KNF:SSO notificatie middels een redirect

Uit Kennisnet Developers Documentatie
Versie door Oostmeijer01 (overleg | bijdragen) op 17 jul 2023 om 13:20 (→‎Foutmeldingen)
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Naar navigatie springen Naar zoeken springen

Entree Federatie-symbol.png Entree Federatie: SSO notificatie middels een redirect

Nl.gif Nederlands En.gif English

Het SSO notificatie cookie kan geplaatst worden door een redirect naar Entree Federatie uit te voeren nadat de gebruiker is ingelogd in de ELO of schoolportaal.

Opbouw redirect URL

De URL waarnaartoe de redirect wordt gedaan bestaat uit vier onderdelen:

  • Voor productie: https://ssonot.entree.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL>
  • Voor staging: https://ssonot.entree-s.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL>

Parameters:

  • id: De unieke identifier waarmee de Identity Provider bekend is binnen Entree Federatie. Dit is het entityId uit de metadata van de Identity Provider. De live data van de WAYF is via een publiek JSON bestand beschikbaar via: https://engine.entree.kennisnet.nl/sso/wayfsearch
  • url: De URL (url-encoded) van de omgeving waar de redirect vandaan komt. Dit wordt in de Entree Federatie applicatie gebruikt voor verificatie.
  • redirectUri: De redirectURI (url-encoded), dit is de URL waar de gebruiker naar teruggestuurd wordt na het plaatsen van het SSO notificatie cookie. Dit zal in veel gevallen hetzelfde zijn als de URL waar de redirect vandaan komt, maar kan indien gewenst dus ook afwijken.

De redirect URL krijgt daarmee de volgende constructie:
https://ssonot.entree.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL>

Whitelist

LET OP: Voordat de SSO notificatie wordt geïmplementeerd moet de URL van de ELO of schoolportaal waarvandaan de redirect wordt uitgevoerd (zie Foutmeldingen) toegevoegd worden aan de whitelist van Entree Federatie. Neem hiervoor contact op met Kennisnet.

Voorbeeld

In onderstaande voorbeeld is http://authenticate.example.org de identifier van de IdP, http://www.example.org de URL waarvandaan de redirect wordt uitgevoerd en http://www.kennisnet.nl de URL waar de gebruiker naar wordt toegestuurd na het plaatsen van de SSO notificatie cookie.
https://ssonot.entree.kennisnet.nl/?id=http://authenticate.example.org&url=http%3A%2F%2Fwww.example.org&redirectUri=http%3A%2F%2Fwww.kennisnet.nl

Foutmeldingen

Als de ingestelde identifier van de IdP niet bekend is binnen Entree Federatie zal de redirect call resulteren in een 400 HTTP status code (Bad request).
Wanneer de URL waarvandaan de call gedaan wordt niet aan de whitelist van Entree Federatie is toegevoegd zal de redirect call ook een 401 HTTP status code (Unauthorized) opleveren.
Wanneer de redirectUri niet aan de whitelist van Entree Federatie is toegevoegd zal de redirect call een 401 HTTP status code (Unauthorized) opleveren.
Neem in deze gevallen contact op met Kennisnet.