A Serviceprovider can use an API to retrieve extra information on a user, after the user has approved this. The approval is done by a consent screen in the OIDC-gateway. The eduID Resource server (client id myconext.rs) needs to be connected to the Relying Party by Surfconext support. The Relying Party needs to request the correct scope(s).
Available API's:
| Endpoint | Parameters | Benodigde scope | Beschrijving | Antwoord |
|---|---|---|---|---|
| https://login.eduid.nl/myconext/api/eduid/eppn | schachome (Add ?schachome=instelling.tld to retrieve only the eppn of the user at this institution) | eduid.nl/eppn | If the user has linked an institution, this will request the eppn(s) for the current user at these institutions | eppn schachome |
| https://login.eduid.nl/myconext/api/eduid/eduid | - | eduid.nl/eduid | Retrieves the targeted eduid-number for the requesting Relying Party | eduid |
| https://login.eduid.nl/myconext/api/eduid/links | - | eduid.nl/links | Returns an array of all linked accounts for the user | schachome eppn displayname |
A testing environment for these requests is available at https://login.test.eduid.nl/myconext/api/*