KNF:ARP service: verschil tussen versies
Regel 11: | Regel 11: | ||
# ARP configuratie voor een school – SP combinatie opvragen: ''/v1/arp/school/{brin}/sp/{organisationCode}'' |
# ARP configuratie voor een school – SP combinatie opvragen: ''/v1/arp/school/{brin}/sp/{organisationCode}'' |
||
# Als Service Provider de eigen ARP configuratie opvragen: ''/v1/arp/sp-config'' |
# Als Service Provider de eigen ARP configuratie opvragen: ''/v1/arp/sp-config'' |
||
+ | |||
+ | De technisch documentatie van de API van de ARP service is te vinden op: https://arpservice.entree.kennisnet.nl/swagger-ui/index.html |
||
==Alle scholen opvragen== |
==Alle scholen opvragen== |
||
+ | Voor het opvragen van de configuratie voor een specifieke onderwijsinstelling - Service Provider configuratie kan gebruik gemaakt worden van het BRIN nummer van de instelling. |
||
+ | Met behulp van de ''school-list'' operatie kunnen alle BRIN nummers die binnen Entree Federatie bekend zijn opgevraagd worden. |
||
+ | |||
+ | Operatie: https://arpservice.entree.kennisnet.nl/v1/arp/school-list |
Versie van 22 mrt 2021 20:38
Inleiding
Door middel van een Attribute Release Policy (ARP) bepaalt een onderwijsinstelling welke attributen (of persoonsgegevens) van haar gebruikers worden doorgegeven aan een Service Provider. Wanneer de configuratie van de ARP onjuist is kan dit ertoe leiden tot verstoring in de toegang tot digitale leermiddelen. De ARP service kan gebruikt worden om de actuele ARP configuratie op te vragen.
Voor het gebruik van de ARP service is een API key nodig. Deze kan worden aangevraagd bij Kennisnet |
De URL voor de ARP service is: https://arpservice.entree.kennisnet.nl
De ARP service kent vier operaties:
- Een lijst met alle scholen opvragen: /v1/arp/school-list
- Een lijst met alle Service Providers opvragen: /v1/arp/sp-list
- ARP configuratie voor een school – SP combinatie opvragen: /v1/arp/school/{brin}/sp/{organisationCode}
- Als Service Provider de eigen ARP configuratie opvragen: /v1/arp/sp-config
De technisch documentatie van de API van de ARP service is te vinden op: https://arpservice.entree.kennisnet.nl/swagger-ui/index.html
Alle scholen opvragen
Voor het opvragen van de configuratie voor een specifieke onderwijsinstelling - Service Provider configuratie kan gebruik gemaakt worden van het BRIN nummer van de instelling. Met behulp van de school-list operatie kunnen alle BRIN nummers die binnen Entree Federatie bekend zijn opgevraagd worden.
Operatie: https://arpservice.entree.kennisnet.nl/v1/arp/school-list