KNF:ARP service

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Entree Federatie-symbol.png Entree Federatie: ARP service

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.

Info.gif 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:

  1. Een lijst met alle scholen opvragen: /v1/arp/school-list
  2. Een lijst met alle Service Providers opvragen: /v1/arp/sp-list
  3. ARP configuratie voor een school – SP combinatie opvragen: /v1/arp/school/{brin}/sp/{organisationCode}
  4. 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 onderwijsinstellingen 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

Antwoord:

[
    {
        "brin": "01JO",
        "friendlyName": "Stichting Koninklijke Auris Groep"
    },
    {
        "brin": "14CR",
        "friendlyName": "Julianaschool"
    },
    {
        "brin": "00NT03",
        "friendlyName": "Prof. Dr. Leo Kannercollege"
    },
    {
        "brin": "25PN01",
        "friendlyName": "ROC Nijmegen VAVO"
    },
    {
        "brin": "02CI02",
        "friendlyName": "Insula College"
    },
    {
        "brin": "17VS02",
        "friendlyName": "Greijdanus Enschede"
    },
    
]