Fiks Protokoll service. Denne speccen består av to API-er:
Protokoll-konfigurasjon brukes til å konfigurere et system utenfor webgrensesnittet. For å kunne ta i bruk dette API, sjekk at API-konfigurering er aktivert på protokollsystem via forvaltning.fiks.ks.no.
", "contact" : { "name" : "Fiks-brukerstøtte", "url" : "https://ks-no.github.io/", "email" : "fiks-utvikling@ks.no" }, "version" : "v1" }, "externalDocs" : { "description" : "Fiks protokoll developers dokumentasjon. Her finner du mer informasjon om Fiks Protokoll og hvordan du setter opp bruk av tjenesten på forvaltningssiden", "url" : "https://developers.fiks.ks.no/tjenester/fiksprotokoll/" }, "servers" : [ { "url" : "https://forvaltning.fiks.ks.no", "description" : "KS Fiks API host" } ], "security" : [ { "bearerAuth" : [ ] } ], "tags" : [ { "name" : "Protokoll-konfigurasjon", "description" : "API for konfigurering av Fiks Protokoll" }, { "name" : "Protokoll-konfigurasjon-kun-person", "description" : "API for konfigurering av Fiks Protokoll" } ], "paths" : { "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer" : { "post" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Opprett konto på system", "operationId" : "createKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateProtokollKontoRequest" } } }, "required" : true }, "responses" : { "201" : { "description" : "Oppretter konto", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/forespurteTilganger/{eksternKonto}" : { "post" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Forespør tilgang til ekstern konto for system", "operationId" : "createTilgangForesporselTilKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "eksternKonto", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "201" : { "description" : "Forespør tilgang til konto" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Fjern forespørsel på tilgang til konto", "operationId" : "removeTilgangForesporselTilKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "eksternKonto", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "204" : { "description" : "Fjern forespørsel på tilgang til konto" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/tilganger/{eksternSystemId}" : { "post" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Gi tilgang til system på konto", "operationId" : "createTilgangTilSystem", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "eksternSystemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "201" : { "description" : "Oppretter tilgang til system" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Fjern tilgang fra system på konto", "operationId" : "removeTilgangTilSystem", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "eksternSystemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "204" : { "description" : "Fjerner tilgang" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Hent protokollkonto", "operationId" : "getKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter konto", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Slett konto fra system", "operationId" : "deleteKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "204" : { "description" : "Sletter konto" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/organisasjoner" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Henter organisasjoner som har systemer som kan gis tilgang til konto", "operationId" : "getFiksOrgsMedSystemer", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter organisasjoner som har systemer som kan gis tilgang til konto, med unntak av gjeldende system. Til bruk for filtrering i søk.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FiksOrgResponse" } } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/forespurteTilganger" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Hent systemer som har forespurt tilgang", "operationId" : "getForespurteTilgangerPaaKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Systemer som har forespurt tilgang", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtokollSystemSummaryWithOrgNameResponse" } } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/protokoller/{protokollnavn}" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Henter parter", "operationId" : "getParterForProtokoll", "parameters" : [ { "name" : "protokollnavn", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter parter", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParterResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/protokoller/{protokollnavn}/{protokollversjon}" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Henter protokolldefinisjon", "operationId" : "getProtokollDefinisjon", "parameters" : [ { "name" : "protokollnavn", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "protokollversjon", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter protokoll", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollDefinisjonResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/protokoller" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Henter alle definerte protokoller", "operationId" : "getProtokollDefinisjoner", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter alle protokoller", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtokollDefinisjonSummaryResponse" } } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Hent system på fiksOrg med systemId", "operationId" : "getSystem", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter system", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollSystemResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Slett system", "operationId" : "deleteSystem", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "204" : { "description" : "Sletter system" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/tilganger" : { "get" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Hent systemer med tilganger på konto", "operationId" : "getSystemerMedTilgangTilKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Systemer med tilgang", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtokollSystemSummaryWithOrgNameResponse" } } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/konto-sok" : { "post" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Søk etter kontoer som systemet kan forespør tilgang til", "operationId" : "kontoSok", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoSokRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Kontoer fra søkeresultat systemet kan forespørre tilgang til", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoSokResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/forespurteTilganger/{eksternSystemId}" : { "delete" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Fjern forespurt tilgang fra system på konto", "operationId" : "removeForespurtTilgangTilKonto", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "eksternSystemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "204" : { "description" : "Fjerner tilgang" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/tilganger/{eksternKontoId}" : { "delete" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Fjern system sin tilgang til konto", "operationId" : "removeTilgangTilKontoForSystem", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "eksternKontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "204" : { "description" : "Fjerner tilgang" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/system-sok" : { "post" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Søk etter systemer som kontoen kan gi tilgang til", "operationId" : "systemSok", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollSystemSokRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Systemer fra søkeresultat som kontoen kan gi tilgang til.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollSystemSokResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/info" : { "put" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Oppdater konto info", "operationId" : "updateKontoInfo", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateProtokollKontoInfoRequest" } } }, "required" : true }, "responses" : { "204" : { "description" : "Oppdater konto info" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/pem" : { "put" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Oppdater offentlig nøkkel på konto ", "operationId" : "updateKontoOffentligNokkel", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateOffentligNokkelRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Oppdater offentlig nøkkel på konto", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OffentligNokkelResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/kontoer/{kontoId}/parter" : { "post" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Oppdater parter på konto", "operationId" : "updateParter", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateParterRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Parter tilknyttet konto", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateParterResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/info" : { "put" : { "tags" : [ "Protokoll-konfigurasjon" ], "description" : "Oppdater info på system", "operationId" : "updateSystemInfo", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateSystemInfoRequest" } } }, "required" : true }, "responses" : { "204" : { "description" : "Oppdater system info (navn, beskrivelse og kontakteposter)" }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer" : { "get" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Hent systemer på fiksOrg", "operationId" : "getSystemerForFiksOrg", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Systemer på fiksOrg", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtokollSystemSummaryResponse" } } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "post" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Opprett system", "operationId" : "createSystem", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateProtokollSystemRequest" } } }, "required" : true }, "responses" : { "201" : { "description" : "Oppretter nytt system", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateProtokollSystemResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/kontoer/{kontoId}" : { "get" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Hent protokollkonto", "operationId" : "getKontoOrganisasjon", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "kontoId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "description" : "Henter konto", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoOrganisasjonResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/konto-sok" : { "post" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Søk etter kontoer tilgjengelig for egen organisasjon", "operationId" : "kontoSokOrganisasjon", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoOrganisasjonSokRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Kontoer fra søkeresultat tilgjengelig på egen organisasjon", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollKontoSokResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/integrasjon-privilegium" : { "put" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Oppdaterer privilegiene til integrasjonen", "operationId" : "updateIntegrasjonsPrivilegium", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateIntegrasjonPrivilegiumRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Oppdaterer privilegiene til integrasjonen", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollSystemResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/fiks-protokoll/api/v1/konfigurasjon/{fiksOrgId}/systemer/{systemId}/orgnummer" : { "put" : { "tags" : [ "Protokoll-konfigurasjon-kun-person" ], "description" : "Oppdater orgnummer på integrasjon ", "operationId" : "updateSystemOrgnummer", "parameters" : [ { "name" : "fiksOrgId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "name" : "systemId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateOrgnummerRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Oppdater systemets integrasjons orgnummer", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProtokollSystemResponse" } } } }, "default" : { "description" : "Noe gikk galt", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } } }, "components" : { "schemas" : { "OffentligNokkelResponse" : { "required" : [ "nokkel", "valid" ], "type" : "object", "properties" : { "nokkel" : { "type" : "string" }, "validFrom" : { "type" : "string", "format" : "date-time" }, "validTo" : { "type" : "string", "format" : "date-time" }, "serial" : { "type" : "string" }, "subjectDN" : { "type" : "string" }, "issuerDN" : { "type" : "string" }, "valid" : { "type" : "boolean" }, "statusMessage" : { "type" : "string" } }, "description" : "Offentlig nøkkel" }, "PartResponse" : { "required" : [ "avsenderMeldingstyper", "beskrivelse", "mottakerMeldingstyper", "navn", "protokollnavn", "protokollversjon", "stottedeParter" ], "type" : "object", "properties" : { "navn" : { "minLength" : 1, "pattern" : "^[A-Za-z0-9\\.\\-_]+$", "type" : "string", "description" : "Navn på part" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av part" }, "protokollnavn" : { "minLength" : 1, "type" : "string", "description" : "Protokollnavn" }, "protokollversjon" : { "minLength" : 1, "type" : "string", "description" : "Protokollversjon" }, "avsenderMeldingstyper" : { "minItems" : 1, "type" : "array", "description" : "Meldingstyper part sender", "items" : { "type" : "string", "description" : "Meldingstyper part sender" } }, "mottakerMeldingstyper" : { "minItems" : 1, "type" : "array", "description" : "Meldingstyper part mottar", "items" : { "type" : "string", "description" : "Meldingstyper part mottar" } }, "stottedeParter" : { "type" : "array", "description" : "Part dette part kan kommunisere med", "items" : { "type" : "string", "description" : "Part dette part kan kommunisere med" } } }, "description" : "Parter protokollkontoen implementerer" }, "ProtokollKontoResponse" : { "required" : [ "beskrivelse", "id", "navn", "parts", "stottetProtokollNavn" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "Id på konto og tilhørende Fiks IO-konto", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på konto" }, "stottetProtokollNavn" : { "minLength" : 1, "type" : "string", "description" : "Protokoll protokollkontoen implementerer" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av kontoen" }, "parts" : { "type" : "array", "description" : "Part protokollkontoen implementerer", "items" : { "$ref" : "#/components/schemas/PartResponse" } }, "offentligNokkel" : { "$ref" : "#/components/schemas/OffentligNokkelResponse" }, "opprettet" : { "type" : "string", "description" : "Tidspunkt protokoll-konto ble opprettet", "format" : "date-time" }, "sistEndret" : { "type" : "string", "description" : "Tidspunkt protokoll-konto sist ble endret", "format" : "date-time" }, "sendMeldingerDeaktivert" : { "type" : "boolean", "description" : "Hvis true, kan kontoen kun motta meldinger og ikke sende meldinger" } } }, "ErrorMessage" : { "type" : "object", "properties" : { "timestamp" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "error" : { "type" : "string" }, "errorId" : { "type" : "string", "format" : "uuid" }, "path" : { "type" : "string" }, "originalPath" : { "type" : "string" }, "message" : { "type" : "string" }, "errorCode" : { "type" : "string" }, "errorJson" : { "type" : "string" } } }, "CreateProtokollKontoRequest" : { "required" : [ "beskrivelse", "navn", "parts", "stottetProtokollNavn" ], "type" : "object", "properties" : { "navn" : { "maxLength" : 200, "minLength" : 1, "pattern" : "^[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü ,.!?\\-:;/\\\\'()&+*=%§]*[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+$", "type" : "string", "description" : "Navn på konto" }, "beskrivelse" : { "maxLength" : 500, "minLength" : 1, "type" : "string", "description" : "Beskrivelse av kontoen" }, "stottetProtokollNavn" : { "maxLength" : 500, "minLength" : 1, "type" : "string" }, "parts" : { "minItems" : 1, "type" : "array", "description" : "Part kontoen implementerer", "items" : { "$ref" : "#/components/schemas/PartRequest" } }, "offentligNokkel" : { "type" : "string", "description" : "Offentlig nøkkel" } } }, "PartRequest" : { "required" : [ "partNavn", "stottetProtokollVersjon" ], "type" : "object", "properties" : { "partNavn" : { "minLength" : 1, "pattern" : "^[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü ,.!?\\-:;/\\\\'()&+*=%§]*[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+$", "type" : "string", "description" : "Navn på konto" }, "stottetProtokollVersjon" : { "minLength" : 1, "type" : "string", "description" : "Protokoll version" } }, "description" : "Part kontoen implementerer" }, "FiksOrgResponse" : { "required" : [ "id", "navn" ], "type" : "object", "properties" : { "navn" : { "type" : "string", "description" : "Navn på fiksOrg" }, "id" : { "type" : "string", "description" : "fiksOrgId", "format" : "uuid" }, "kommunenummer" : { "type" : "string", "description" : "Kommunenummer dersom fiksOrg er kommune" } }, "description" : "FiksOrg til eier av systemet" }, "ProtokollSystemSummaryWithOrgNameResponse" : { "required" : [ "beskrivelse", "fiksOrgNavn", "id", "navn" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "System-id", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på system" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av system" }, "fiksOrgNavn" : { "minLength" : 1, "type" : "string", "description" : "Navn for fiksOrg" } } }, "ParterResponse" : { "type" : "object", "properties" : { "parter" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PartResponse" } } } }, "CreateProtokollMeldingstype" : { "required" : [ "meldingstypeNavn" ], "type" : "object", "properties" : { "meldingstypeNavn" : { "type" : "string", "description" : "Navnet på meldingstype" }, "payloadKriterie" : { "type" : "string", "description" : "Preferanse for payload", "enum" : [ "NEVER", "REQUIRED", "OPTIONAL" ] } }, "description" : "Meldingstyper protokollen støtter" }, "ProtokollDefinisjonResponse" : { "required" : [ "beskrivelse", "meldingstyper", "navn", "parter", "protokollversjon", "status" ], "type" : "object", "properties" : { "navn" : { "minLength" : 1, "pattern" : "^[A-Za-z0-9\\.\\-_]+$", "type" : "string", "description" : "Navn på protokoll" }, "protokollversjon" : { "minLength" : 1, "pattern" : "^[A-Za-z0-9\\.\\-_]+$", "type" : "string", "description" : "Protokollversjon" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av protokoll" }, "meldingstyper" : { "type" : "array", "description" : "Meldingstyper protokollen støtter", "items" : { "$ref" : "#/components/schemas/CreateProtokollMeldingstype" } }, "parter" : { "type" : "array", "description" : "Parter definert på protokollen", "items" : { "$ref" : "#/components/schemas/PartResponse" } }, "status" : { "type" : "string", "description" : "Status på protokoll", "enum" : [ "AKTIV", "DEAKTIVERT" ] } } }, "ProtokollDefinisjonSummaryResponse" : { "required" : [ "beskrivelse", "navn", "parter", "protokollversjon", "status" ], "type" : "object", "properties" : { "navn" : { "minLength" : 1, "pattern" : "^[A-Za-z0-9\\.\\-_]+$", "type" : "string", "description" : "Navn på protokoll" }, "protokollversjon" : { "minLength" : 1, "pattern" : "^[A-Za-z0-9\\.\\-_]+$", "type" : "string", "description" : "Protokollversjon" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av protokoll" }, "parter" : { "type" : "array", "description" : "Navn på parter definert på protokollen", "items" : { "type" : "string", "description" : "Navn på parter definert på protokollen" } }, "status" : { "type" : "string", "description" : "Status på protokoll", "enum" : [ "AKTIV", "DEAKTIVERT" ] } } }, "EksternProtokollKontoResponse" : { "required" : [ "beskrivelse", "id", "navn", "parter", "stottetProtokollNavn", "system" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "Id på konto og tilhørende Fiks IO-konto", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på konto" }, "stottetProtokollNavn" : { "minLength" : 1, "type" : "string", "description" : "Protokoll protokollkontoen implementerer" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av kontoen" }, "parter" : { "type" : "array", "description" : "Parter protokollkontoen implementerer", "items" : { "$ref" : "#/components/schemas/PartResponse" } }, "system" : { "$ref" : "#/components/schemas/EksternProtokollSystemResponse" } }, "description" : "Kontoer systemet har har forespurt tilgang til" }, "EksternProtokollSystemResponse" : { "required" : [ "beskrivelse", "fiksOrg", "id", "navn" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "System-id", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på system" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av system" }, "fiksOrg" : { "$ref" : "#/components/schemas/FiksOrgResponse" } }, "description" : "Eiersystem" }, "PartSummaryResponse" : { "required" : [ "navn", "protokollnavn", "protokollversjon" ], "type" : "object", "properties" : { "navn" : { "minLength" : 1, "pattern" : "^[A-Za-z0-9\\.\\-_]+$", "type" : "string", "description" : "Navn på part" }, "protokollnavn" : { "minLength" : 1, "type" : "string", "description" : "Protokollnavn" }, "protokollversjon" : { "minLength" : 1, "type" : "string", "description" : "Protokollversjon" } }, "description" : "Parter protokollkontoen implementerer" }, "ProtokollKontoMetrikkResponse" : { "type" : "object", "properties" : { "meldingerPaKo" : { "type" : "integer", "description" : "Antall meldinger på kø", "format" : "int32" }, "antallKonsumenter" : { "type" : "integer", "description" : "Antall konsumenter for protokollkonto", "format" : "int32" } }, "description" : "Metrikk for konto" }, "ProtokollKontoSummaryResponse" : { "required" : [ "beskrivelse", "id", "navn", "parter", "stottetProtokollNavn" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "Id på konto og tilhørende Fiks IO-konto", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på konto" }, "stottetProtokollNavn" : { "minLength" : 1, "type" : "string", "description" : "Protokoll protokollkontoen implementerer" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av kontoen" }, "parter" : { "type" : "array", "description" : "Parter protokollkontoen implementerer", "items" : { "$ref" : "#/components/schemas/PartSummaryResponse" } }, "metrikk" : { "$ref" : "#/components/schemas/ProtokollKontoMetrikkResponse" }, "sendMeldingerDeaktivert" : { "type" : "boolean", "description" : "Hvis true, kan kontoen kun motta meldinger og ikke sende meldinger" } }, "description" : "Kontoer" }, "ProtokollSystemResponse" : { "required" : [ "automatiskGodkjenning", "beskrivelse", "eposter", "forespurteTilgangerTilKontoer", "id", "integrasjonId", "konfigureresAvIntegrasjon", "kontoer", "navn", "offentlig", "orgnummer", "tilgangTilKontoer" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "System-id", "format" : "uuid" }, "integrasjonId" : { "minLength" : 1, "type" : "string", "description" : "Integrasjon-id", "format" : "uuid" }, "orgnummer" : { "minLength" : 1, "pattern" : "^[0-9]{9}$", "type" : "string", "description" : "Orgnummer for organisasjon" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på system" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av system" }, "eposter" : { "minItems" : 1, "type" : "array", "description" : "Kontakteposter", "items" : { "type" : "string", "description" : "Kontakteposter", "pattern": "^[A-Za-zæøåÆØÅ0-9-_]+([.+][A-Za-zæøåÆØÅ0-9-_]+)*@[A-Za-zæøåÆØÅ0-9-]+(\\.[A-Za-zæøåÆØÅ0-9-]+)*(\\.[A-Za-z]{2,})$" } }, "kontoer" : { "minItems" : 1, "type" : "array", "description" : "Kontoer", "items" : { "$ref" : "#/components/schemas/ProtokollKontoSummaryResponse" } }, "tilgangTilKontoer" : { "minItems" : 1, "type" : "array", "description" : "Kontoer systemet har tilgang på", "items" : { "$ref" : "#/components/schemas/EksternProtokollKontoResponse" } }, "forespurteTilgangerTilKontoer" : { "minItems" : 1, "type" : "array", "description" : "Kontoer systemet har har forespurt tilgang til", "items" : { "$ref" : "#/components/schemas/EksternProtokollKontoResponse" } }, "offentlig" : { "type" : "boolean", "description" : "Begrenser synlighet utover egen organisasjon" }, "automatiskGodkjenning" : { "type" : "boolean", "description" : "Godkjenner automatisk forespørsler om tilgang" }, "konfigureresAvIntegrasjon" : { "type" : "boolean", "description" : "Konfigureres av integrasjon" }, "leverandorNavn" : { "type" : "string", "description" : "Systemleverandør" }, "leverandorKontaktpunkt" : { "type" : "string", "description" : "Kontaktpunkt for systemleverendør" }, "fiksOrg" : { "$ref" : "#/components/schemas/FiksOrgResponse" }, "opprettet" : { "type" : "string", "description" : "Tidspunkt protokoll-system ble opprettet", "format" : "date-time" }, "sistEndret" : { "type" : "string", "description" : "Tidspunkt protokoll-system sist ble endret", "format" : "date-time" } } }, "ProtokollKontoSokResponse" : { "required" : [ "kontoer" ], "type" : "object", "properties" : { "kontoer" : { "type" : "array", "description" : "Systemer som ble funnet av søk", "items" : { "$ref" : "#/components/schemas/EksternProtokollKontoResponse" } } } }, "ProtokollKontoSokFilterRequest" : { "type" : "object", "properties" : { "fiksOrgIder" : { "type" : "array", "description" : "Liste over fiksOrgIder som kontoen må være eid av", "items" : { "type" : "string", "description" : "Liste over fiksOrgIder som kontoen må være eid av", "format" : "uuid" } }, "protokollFilter" : { "type" : "array", "description" : "Protokoller som kontoen må være del av", "items" : { "$ref" : "#/components/schemas/ProtokollSokFilterRequest" } } }, "description" : "Filter for søk etter protokollkontoer" }, "ProtokollKontoSokRequest" : { "type" : "object", "properties" : { "filter" : { "$ref" : "#/components/schemas/ProtokollKontoSokFilterRequest" }, "term" : { "type" : "string", "description" : "Søketerm på kontonavn, kontoId, kontobeskrivelse, systemnavn og/eller systembeskrivelse" } } }, "ProtokollSokFilterRequest" : { "required" : [ "protokollNavn", "protokollVersjon" ], "type" : "object", "properties" : { "protokollNavn" : { "type" : "string", "description" : "Navn på protokoll" }, "protokollVersjon" : { "type" : "string", "description" : "Versjon av protokoll" }, "parter" : { "type" : "array", "description" : "Parter", "items" : { "type" : "string", "description" : "Parter" } } }, "description" : "Protokoller som kontoen må være del av" }, "ProtokollSystemSokResponse" : { "required" : [ "systemer" ], "type" : "object", "properties" : { "systemer" : { "type" : "array", "description" : "Systemer som ble funnet av søk", "items" : { "$ref" : "#/components/schemas/EksternProtokollSystemResponse" } } } }, "ProtokollSystemSokFilterRequest" : { "type" : "object", "properties" : { "fiksOrgIder" : { "type" : "array", "description" : "Liste over fiksOrgIder som systemet må være eid av", "items" : { "type" : "string", "description" : "Liste over fiksOrgIder som systemet må være eid av", "format" : "uuid" } }, "stotterKonto" : { "type" : "boolean", "description" : "Returnerer kun systemer som støtter kontoen som søker (default: true)" } }, "description" : "Filter for søk etter protokollsystem" }, "ProtokollSystemSokRequest" : { "type" : "object", "properties" : { "filter" : { "$ref" : "#/components/schemas/ProtokollSystemSokFilterRequest" }, "term" : { "type" : "string", "description" : "Søketerm på kontonavn, kontobeskrivelse, systemnavn og/eller systembeskrivelse" } } }, "UpdateProtokollKontoInfoRequest" : { "required" : [ "beskrivelse", "navn" ], "type" : "object", "properties" : { "navn" : { "maxLength" : 200, "minLength" : 1, "pattern" : "^[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü ,.!?\\-:;/\\\\'()&+*=%§]*[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+$", "type" : "string", "description" : "Navn på konto" }, "beskrivelse" : { "maxLength" : 500, "minLength" : 1, "type" : "string", "description" : "Beskrivelse av kontoen" } } }, "UpdateOffentligNokkelRequest" : { "required" : [ "offentligNokkel" ], "type" : "object", "properties" : { "offentligNokkel" : { "type" : "string", "description" : "Offentlig nøkkel" } } }, "UpdateParterResponse" : { "required" : [ "parter" ], "type" : "object", "properties" : { "parter" : { "type" : "array", "description" : "Parter tilknyttet konto", "items" : { "$ref" : "#/components/schemas/PartResponse" } } } }, "UpdateParterRequest" : { "required" : [ "parts" ], "type" : "object", "properties" : { "parts" : { "minItems" : 1, "type" : "array", "description" : "Part kontoen implementerer", "items" : { "$ref" : "#/components/schemas/PartRequest" } } } }, "UpdateSystemInfoRequest" : { "required" : [ "beskrivelse", "eposter", "navn", "offentlig" ], "type" : "object", "properties" : { "navn" : { "maxLength" : 200, "minLength" : 1, "pattern" : "^[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü ,.!?\\-:;/\\\\'()&+*=%§]*[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+$", "type" : "string", "description" : "Navn på system" }, "beskrivelse" : { "maxLength" : 500, "minLength" : 1, "type" : "string", "description" : "Beskrivelse av system" }, "eposter" : { "minItems" : 1, "type" : "array", "description" : "Kontakteposter", "items" : { "type" : "string", "description" : "Kontakteposter", "pattern": "^[A-Za-zæøåÆØÅ0-9-_]+([.+][A-Za-zæøåÆØÅ0-9-_]+)*@[A-Za-zæøåÆØÅ0-9-]+(\\.[A-Za-zæøåÆØÅ0-9-]+)*(\\.[A-Za-z]{2,})$" } }, "offentlig" : { "type" : "boolean", "description" : "Begrenser synlighet utover egen organisasjon" }, "automatiskGodkjenning" : { "type" : "boolean", "description" : "Godkjenner automatisk forespørsler om tilgang" }, "leverandorNavn" : { "type" : "string", "description" : "Systemleverandør" }, "leverandorKontaktpunkt" : { "type" : "string", "description" : "Kontaktpunkt for systemleverendør" } } }, "CreateProtokollSystemResponse" : { "required" : [ "integrasjonPassord", "system" ], "type" : "object", "properties" : { "system" : { "$ref" : "#/components/schemas/ProtokollSystemResponse" }, "integrasjonPassord" : { "minLength" : 1, "type" : "string", "description" : "Integrasjonspassord for systemet" } } }, "CreateProtokollSystemRequest" : { "required" : [ "beskrivelse", "eposter", "konfigureresAvIntegrasjon", "navn", "offentlig", "orgnummer" ], "type" : "object", "properties" : { "orgnummer" : { "minLength" : 1, "pattern" : "^[0-9]{9}$", "type" : "string", "description" : "Orgnummer for oppretting av integrasjon" }, "navn" : { "maxLength" : 200, "minLength" : 1, "pattern" : "^[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü ,.!?\\-:;/\\\\'()&+*=%§]*[A-ZÆØÅa-zæøå0-9ÁáÀàÂâÉéÈèÊêÍíÌìÎîÓóÒòÔôÚúÙùÛûÝýÄäËëÏïÖöÜü,.!?\\-:;/\\\\'()&+*=%§]+$", "type" : "string", "description" : "Navn på system" }, "beskrivelse" : { "maxLength" : 500, "minLength" : 1, "type" : "string", "description" : "Beskrivelse av system" }, "eposter" : { "minItems" : 1, "type" : "array", "description" : "Kontakteposter", "items" : { "type" : "string", "description" : "Kontakteposter", "pattern": "^[A-Za-zæøåÆØÅ0-9-_]+([.+][A-Za-zæøåÆØÅ0-9-_]+)*@[A-Za-zæøåÆØÅ0-9-]+(\\.[A-Za-zæøåÆØÅ0-9-]+)*(\\.[A-Za-z]{2,})$" } }, "offentlig" : { "type" : "boolean", "description" : "Offentlig, styrer om systemet skal være synling for andre Fiks organisasjoner" }, "automatiskGodkjenning" : { "type" : "boolean", "description" : "Automatisk godkjenning, styrer om systemet automatisk skal godkjenne forespørsler om tilgang" }, "konfigureresAvIntegrasjon" : { "type" : "boolean", "description" : "Konfigureres av integrasjon" }, "leverandorNavn" : { "maxLength" : 100, "minLength" : 0, "type" : "string", "description" : "Systemleverandør" }, "leverandorKontaktpunkt" : { "maxLength" : 100, "minLength" : 0, "type" : "string", "description" : "Kontaktpunkt for systemleverendør" } } }, "ProtokollKontoOrganisasjonResponse" : { "required" : [ "beskrivelse", "fiksOrgId", "id", "navn", "parts", "stottetProtokollNavn", "systemId" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Id på konto og tilhørende Fiks IO-konto", "format" : "uuid" }, "fiksOrgId" : { "type" : "string", "description" : "FiksOrgId for system på konto", "format" : "uuid" }, "systemId" : { "type" : "string", "description" : "SystemId på konto", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på konto" }, "stottetProtokollNavn" : { "minLength" : 1, "type" : "string", "description" : "Protokoll protokollkontoen implementerer" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av kontoen" }, "parts" : { "type" : "array", "description" : "Part protokollkontoen implementerer", "items" : { "$ref" : "#/components/schemas/PartResponse" } }, "offentligNokkel" : { "$ref" : "#/components/schemas/OffentligNokkelResponse" }, "opprettet" : { "type" : "string", "description" : "Tidspunkt protokoll-konto ble opprettet", "format" : "date-time" }, "sistEndret" : { "type" : "string", "description" : "Tidspunkt protokoll-konto sist ble endret", "format" : "date-time" }, "sendMeldingerDeaktivert" : { "type" : "boolean", "description" : "Hvis true, kan kontoen kun motta meldinger og ikke sende meldinger" } } }, "ProtokollSystemSummaryResponse" : { "required" : [ "beskrivelse", "id", "navn" ], "type" : "object", "properties" : { "id" : { "minLength" : 1, "type" : "string", "description" : "System-id", "format" : "uuid" }, "navn" : { "minLength" : 1, "type" : "string", "description" : "Navn på system" }, "beskrivelse" : { "minLength" : 1, "type" : "string", "description" : "Beskrivelse av system" } } }, "ProtokollKontoOrganisasjonSokRequest" : { "required" : [ "filter" ], "type" : "object", "properties" : { "filter" : { "$ref" : "#/components/schemas/ProtokollKontoSokFilterRequest" }, "term" : { "type" : "string", "description" : "Søketerm på kontonavn, kontoId, kontobeskrivelse, systemnavn og/eller systembeskrivelse" } } }, "UpdateIntegrasjonPrivilegiumRequest" : { "required" : [ "konfigureresAvIntegrasjon" ], "type" : "object", "properties" : { "konfigureresAvIntegrasjon" : { "type" : "boolean", "description" : "Skal systemet konfigureres av integrasjonen?" } } }, "UpdateOrgnummerRequest" : { "required" : [ "orgnummer" ], "type" : "object", "properties" : { "orgnummer" : { "pattern" : "^[0-9]{9}$", "type" : "string", "description" : "Organisasjonsnummer" } } } }, "securitySchemes" : { "bearerAuth" : { "type" : "http", "scheme" : "bearer", "bearerFormat" : "JWT" } } } }