...
Om de gebruikerscontext door te geven aan een aanvraagmodule moet het OAuth Access Token - verkregen via de voorgaande Token Exchange - worden doorgegeven vanuit Mijn Burgerprofiel. Gezien de gevoeligheid van het OAuth Access Token moet dit altijd via een server-to-server operatie verlopen. De server-to-server operatie verloopt
Om dit te bereiken dient de aanvraagmodule een API endpoint te voorzien volgens onderstaande API specificatie en . Mijn Burgerprofiel (server) roept dit endpoint dan aan om een OAuth Access token te registreren. De registratie moet resulteren in een tijdelijk, éénmalig te gebruiken token (dat dan doorgegeven wordt bij het openen van de aanvraagmodule in de browser, zie verder).
| Info |
|---|
Opmerking: Mijn Burgerprofiel zal gebruik maken van de Client ID vermeld in de Formulieren API response om de “audience” claim correct in te stellen tijdens het Token Exchange proces. |
| Swagger integration | ||
|---|---|---|
| ||
{
"openapi": "3.0.2",
"info": {
"title": "Aanvraagmodule - SSO Token",
"version": "1.0"
},
"components": {
"schemas": {
"RequestToken": {
"type": "object",
"required": [
"token",
"token_type"
],
"properties": {
"token": {
"type": "string",
"description": "Token ontvangen via IdP Token Exchange"
},
"token_type": {
"type": "string",
"description": "Type token ontvangen via IdP Token Exchange",
"enum": [
"urn:ietf:params:oauth:token-type:access_token"
]
}
}
},
"ResponseTempToken": {
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "Tijdelijk SSO Token"
}
}
},
"ClientError": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"description": "Foutmelding"
}
}
},
"ServerError": {
"type": "string"
}
}
},
"servers": [
{
"description": "Form provider",
"url": "https://formulier.vlaanderen.be"
}
],
"paths": {
"/auth/v1/token": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestToken"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/RequestToken"
}
}
}
},
"responses": {
"200": {
"description": "Vraagstelling is geaccepteerd en een tijdelijk token werd gegenereerd",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseTempToken"
}
}
}
},
"400": {
"description": "Vraagstelling ontbreekt verplichte velden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"401": {
"description": "Ongeldig of vervallen token in de vraagstelling",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"500": {
"description": "Onverwacht probleem opgetreden in de applicatie bij het verwerken van het token",
"content": {
"text/html": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
}
}
}
}
} |
Tot slot zal het Het verkregen tijdelijk token zal door Mijn Burgerprofiel worden doorgegeven als query parameter via de formulier URL. De exacte waarde die gebruikt zal worden voor de query parameter naam dient door te stromen via de Formulieren API specificatie.
...