Skip to content

Commit

Permalink
Feaute/docsupdatesysuser (#1823)
Browse files Browse the repository at this point in the history 
* docs update

* Updates
  • Loading branch information
@TheTechArch
TheTechArch authored Oct 11, 2024
1 parent d982783 commit 9cdad19
Show file tree
Hide file tree
Showing 3 changed files with 341 additions and 66 deletions.
4 changes: 3 additions & 1 deletion content/authentication/what-do-you-get/systemuser/_index.nb.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Systembruker
description: En stor del av bruken av Altinn er via API fra fagsystemer. Dette er programvare som har integrert seg Altinns API og man fra programvare kan f.eks. sende inn skjema eller hente ut meldinger av forskjellig art.
description: En stor del av kommunikasjonen mellom det offentlige og næringslivet skjer via API i Altinn og andre hos andre platformleverandører i det offentlige.
tags: [platform, authentication]
toc: false
weight: 1
Expand All @@ -11,6 +11,8 @@ aliases:
{{<notice warning>}}
Under arbeid. Ting kan endres. Vi tar gjerne imot innspill.
{{</notice>}}


Omtrent 50% av skjematrafikken kommer via API, med enkelte tjenester som har nesten 100% fra fagsystemer.

Nye autentiserings- og autorisasjonsmekanismer utvikles nå for maskin-til-maskin-integrasjon på Altinn-plattformen og andre offentlige API-er.
Expand Down
213 changes: 155 additions & 58 deletions static/swagger/altinn-platform-authentication-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -345,17 +345,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
Expand Down Expand Up @@ -387,17 +387,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
Expand Down Expand Up @@ -446,17 +446,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
Expand Down Expand Up @@ -496,17 +496,17 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
Expand Down Expand Up @@ -548,17 +548,110 @@
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateRequestSystemUserResponse"
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
}
}
}
},
"/systemuser/request/vendor/bysystem/{systemId}": {
"get": {
"tags": [
"RequestSystemUser"
],
"summary": "Retrieves a list of Status-Response-model for all Requests that the Vendor has for a given system they own.",
"parameters": [
{
"name": "systemId",
"in": "path",
"description": "The system the Vendor wants the list for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
}
}
}
},
"/systemuser/request/{party}/{requestId}/reject": {
"post": {
"tags": [
"RequestSystemUser"
],
"summary": "Rejects the systemuser request",
"parameters": [
{
"name": "party",
"in": "path",
"description": "the partyId",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "requestId",
"in": "path",
"description": "The UUID of the request to be rejected",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestSystemResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RequestSystemResponse"
}
}
}
Expand Down Expand Up @@ -1264,49 +1357,6 @@
},
"additionalProperties": false
},
"CreateRequestSystemUserResponse": {
"required": [
"id",
"partyOrgNo",
"rights",
"status",
"systemId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"externalRef": {
"type": "string",
"nullable": true
},
"systemId": {
"minLength": 1,
"type": "string"
},
"partyOrgNo": {
"minLength": 1,
"type": "string"
},
"rights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Right"
}
},
"status": {
"minLength": 1,
"type": "string"
},
"redirectUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DiscoveryDocument": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1609,6 +1659,53 @@
},
"additionalProperties": false
},
"RequestSystemResponse": {
"required": [
"id",
"partyOrgNo",
"rights",
"status",
"systemId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"externalRef": {
"type": "string",
"nullable": true
},
"systemId": {
"minLength": 1,
"type": "string"
},
"partyOrgNo": {
"minLength": 1,
"type": "string"
},
"rights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Right"
}
},
"status": {
"minLength": 1,
"type": "string"
},
"redirectUrl": {
"type": "string",
"nullable": true
},
"confirmUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Right": {
"type": "object",
"properties": {
Expand Down
Loading

0 comments on commit 9cdad19

Please sign in to comment.