Document toolboxDocument toolbox

(MedMij Afsprakenstelsel 2.0.0) Token interface, Abonneren

Owned by Ibrahim Benyahya
Sept 06, 2023
2 min read


Op deze pagina staan alleen de verantwoordelijkheden inzake het token interface die nog niet genoemd staan in de OAuth 2-specificatie.

1.

De parameters in de access-token response worden als volgt gevuld:

parametervullingtoelichting
scope

Conform sectie 5.1 van de OAuth 2.0-specificatie.

In toevoeging daarop: verplicht indien het authorization request verzocht om een Abonnement. In dat geval is de scope-parameter gelijk aan die in de betreffende authorization request, maar met de Abonnements-einddatum gesteld op de door de Authorization Server toegekende, en dus mogelijk beperkte, waarde. De toegekende duur van het Abonnement is:

  • niet hoger dan de in de authorization request gevraagde duur van het Abonnement;
  • niet hoger dan de maximale abonnementsduur die de Aanbieder in de Aanbiederslijst had opgenomen bij die Gegevensdienst en die Interfaceversie;
  • bij een gevraagde beëindiging gelijk aan 0.

In toevoeging daarop:

  1. Verplicht indien het authorization request verzocht om (MedMij Afsprakenstelsel 2.0.0) Verzamelen van meerdere Gegevensdiensten en hiervan niet alle Gegevensdiensten beschikbaar bleken voor Persoon. In dat geval is de scope-parameter gelijk aan die in de betreffende authorization request, met daaruit weggelaten de niet-beschikbare zorgaanbieder-gegevensdienst-combinaties.
  2. Verplicht indien het authorization request verzocht om een Abonnement. In dat geval is de scope-parameter gelijk aan die in de betreffende authorization request, maar met de Abonnements-einddatum gesteld op de door de Authorization Server toegekende, en dus mogelijk beperkte, waarde. De toegekende duur van het Abonnement is:
    • niet hoger dan de in de authorization request gevraagde duur van het Abonnement;
    • niet hoger dan de maximale abonnementsduur die de Aanbieder in de Aanbiederslijst had opgenomen bij die Gegevensdienst en die Interfaceversie;
    • bij een gevraagde beëindiging gelijk aan 0.

Bovenstaande tabel is een uitbreiding op de tabel die is weergegeven in core.tknint.201

ext.abo.tknint.200

2.

Na ontvangst van een access token request, in de functies Verzamelen, (MedMij Afsprakenstelsel 2.0.0) Delen of (MedMij Afsprakenstelsel 2.0.0) Abonneren, zal de OAuth Authorization Server, indien in antwoord daarop een access token dient te worden uitgegeven, na maximaal tien (10) seconden dit acces token ter beschikking stellen aan de OAuth Client. Dit gedrag van de OAuth Authorization Server is gedurende minimaal 99,5% van de tijd beschikbaar.

Bovenstaande tabel is een uitbreiding op de tabel die is weergegeven in core.tknint.206

ext.abo.tknint.201

3.

OAuth Authorization Server en OAuth Client behandelen uitzonderingssituaties inzake het token interface volgens onderstaande tabel.

NummerImplementeert uitzonderingUitzonderingActieMeldingVervolg
Token interface 1

Abonneren 3

Authorization Server moet vanwege één van de in de OAuth 2.0-specificatie, par. 5.2, genoemde redenen de token request weigeren.Authorization Server informeert DVP Server over deze uitzondering. DVP Server informeert daarop Persoon hierover.met de conform OAuth 2.0-specificatie, par. 5.2, toepasselijke error codeAllen stoppen de flow onmiddellijk na geïnformeerd te zijn over de uitzondering.
 Toelichting

De uitzonderingssituaties  kunnen gezien worden als de implementatie-tegenhangers van de uitzonderingen van de functies (MedMij Afsprakenstelsel 2.0.0) Verzamelen en de (MedMij Afsprakenstelsel 2.0.0) Delen. Op de Applicatielaag zijn deze echter per interface geordend. Alle uitzonderingen worden door de Authorization Server ontdekt. In deze versie van het MedMij Afsprakenstelsel is bepaald dat zij altijd leiden tot het zo snel mogelijk afbreken van de flow door alle betrokken rollen. Daartoe moeten echter eerst nog de andere rollen geïnformeerd worden.

Deze tabel bevat alleen die uitzonderingssituaties ten aanzien waarvan het MedMij afsprakenstelsel eigen eisen stelt aan de implementatie. In de specificatie van OAuth 2.0 staan daarnaast nog generiekere uitzonderingssituaties, zoals de situatie waarin de redirect URI ongeldig blijkt. Ook deze uitzonderingssituaties moeten geïmplementeerd worden.

ext.abo.tknint.202