KNF:Attributen overzicht voor Identity Providers: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Regel 35: Regel 35:
 
Deze attributen worden alleen aan de Service Provider doorgegeven indien de school hiervoor expliciet toestemming heeft gegeven via een ondertekende [https://support.kennisnet.org/index.php?/Knowledgebase/Article/View/226/0/wat-is-een-arp Attribute Release Policy].
 
Deze attributen worden alleen aan de Service Provider doorgegeven indien de school hiervoor expliciet toestemming heeft gegeven via een ondertekende [https://support.kennisnet.org/index.php?/Knowledgebase/Article/View/226/0/wat-is-een-arp Attribute Release Policy].
 
{| class="wikitable"
 
{| class="wikitable"
! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
+
! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''
 
|-
 
|-
| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepukkelen@petteflatcollege
+
| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Unencrypted version of the uid || [userId]@[realm] || pietjepukkelen@petteflatcollege
 
|-
 
|-
| givenName || Voornaam || vrij tekstveld || Pietje
+
| givenName || First name || string || Pietje
 
|-
 
|-
| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
+
| nlEduPersonTussenvoegsels || Tussenvoegsel || string || van
 
|-
 
|-
| sn || Achternaam || vrij tekstveld || Pukkelen
+
| sn || Surname || string || Pukkelen
 
|-
 
|-
| mail || Email adres || vrij tekstveld || pietjepuk@petteflatcollege.nl
+
| mail || Email address || string || pietjepuk@petteflatcollege.nl
 
|-
 
|-
| initials || Initalen || vrij tekstveld || P.
+
| initials || Initals || string || P.
 
|-
 
|-
| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
+
| homePhone || Phone number || string || +31791234567
 
|-
 
|-
| mobile || Mobiel nummer || vrij tekstveld || +31612345678
+
| mobile || Mobile number || string || +31612345678
 
|-
 
|-
| homePostalAddress || Adres || Maximum 6 regels van elk 30 karakters || Petteflat 121e <br/> 2518PP Zoetermeer
+
| homePostalAddress || Address || Maximum of 6 lines each containing maximum 30 characters || Petteflat 121e <br/> 2518PP Zoetermeer
 
|-
 
|-
| nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
+
| nlEduPersonBirthDate || Date of birth|| yyyymmdd || 19801231
 
|-
 
|-
 
| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO[spatie].<br/>Optioneel kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper
 
| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO[spatie].<br/>Optioneel kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper
 
|-
 
|-
| nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek
+
| nlEduPersonDepartment || Department or sector || string || Techniek
 
|-
 
|-
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A
+
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || string || H2A
 
|-
 
|-
| ou || Klas of groep || vrij tekstveld || H2A
+
| ou || Klas of groep || string || H2A
 
|-
 
|-
| nlEduPersonCohort || Startjaar || vrij tekstveld || 2014
+
| nlEduPersonCohort || Starting year || string || 2014
 
|-
 
|-
| nlEduPersonProfileId || ECK attribuut<br/>Indien een school meerdere administraties voert kan het administratienummer worden toegevoegd achter het @, zoals in het voorbeeld || leerlingnummer@administratienummer.schooldomein.nl || 95312@1.kennisnet.nl
+
| nlEduPersonProfileId || ECK attribute<br/>Indien een school meerdere administraties voert kan het administratienummer worden toegevoegd achter het @, zoals in het voorbeeld || leerlingnummer@administratienummer.schooldomein.nl || 95312@1.kennisnet.nl
 
|-
 
|-
| ocwILTRegistratiecode || ILT Registratiecode<br/>''Conform bijlage I en II, behorende bij artikel 1 van de Regeling van de Minister OCW houdende vaststelling van de Elementcodetabel en Vakcodetabel VO en Volwasseneneducatie: nr. DUO/OND-2013/15135 M.'' || vier cijferige-code || 0011
+
| ocwILTRegistratiecode || ILT Registrationcode<br/>''Conform bijlage I en II, behorende bij artikel 1 van de Regeling van de Minister OCW houdende vaststelling van de Elementcodetabel en Vakcodetabel VO en Volwasseneneducatie: nr. DUO/OND-2013/15135 M.'' || four digits || 0011
 
|-
 
|-
| ocwILTLeerjaar || ILT Leerjaar<br/>''Conform bijlage I en II, behorende bij artikel 1 van de Regeling van de Minister OCW houdende vaststelling van de Elementcodetabel en Vakcodetabel VO en Volwasseneneducatie: nr. DUO/OND-2013/15135 M.'' || 1 cijfer || 1
+
| ocwILTLeerjaar || ILT cohort<br/>''Conform bijlage I en II, behorende bij artikel 1 van de Regeling van de Minister OCW houdende vaststelling van de Elementcodetabel en Vakcodetabel VO en Volwasseneneducatie: nr. DUO/OND-2013/15135 M.'' || 1 digit || 1
 
|}
 
|}
 
'''<sup>1</sup> Let op:''' De versleutelde versie van dit attribuut wordt altijd doorgegeven (zie standaard attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.<br/>
 
'''<sup>1</sup> Let op:''' De versleutelde versie van dit attribuut wordt altijd doorgegeven (zie standaard attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.<br/>

Versie van 24 okt 2016 20:56

Nl.gif Nederlands En.gif English


Om een gebruiker te authentiseren en vervolgens te autoriseren wordt binnen Entree Federatie gebruik gemaakt van attributen. Deze attributen bevatten informatie (bijvoorbeeld een voornaam) over de gebruiker die bij een aangesloten dienst wil inloggen.
De set van attributen bestaat uit twee typen attributen:

  • Standaard attributen
  • Aanvullende attributen

Voor de meeste dienstleveranciers zal de basisset met standaard attributen voldoende zijn om gebruikers te authentiseren en te autoriseren. Er kunnen zich echter situaties voordoen waarin een Service Provider meer informatie over een gebruiker nodig heeft, in dat geval kan er gebruik worden gemaakt van één of meerdere aanvullende attributen.

Om als Identity Provider de toegang tot alle aangesloten diensten voor gebruikers mogelijk te maken, is het belangrijk om naast de set met standaard attributen ook de aanvullende attributen te ondersteunen.

Standaard attributen

Hieronder staan de attributen die altijd door de Identity Provider aan Entree Federatie moeten worden doorgegeven

Attribuutnaam Beschrijving Formaat Voorbeeld
uid Uniek kenmerk van de gebruiker, bestaand uit een gebruikersnaam en omgeving 1 userId@realm pietjepukkelen@petteflatcollege
employeeNumber Leerlingnummer vrij tekstveld 140136
givenName Voornaam vrij tekstveld Pietje
sn Achternaam vrij tekstveld Pukkelen
eduPersonAffiliation Rol student, employee, staff of affiliate student
nlEduPersonHomeOrganizationId Brin nummer van de instelling 4 of 6 karakters 11ZZ03
nlEduPersonHomeOrganization Naam van de instelling vrij tekstveld Petteflat College

1 Let op: Voor een SAML koppeling moet de waarde van het uid attribuut gelijk zijn aan de waarde van het <saml:NameID> veld.

Aanvullende attributen

Deze attributen worden alleen aan de Service Provider doorgegeven indien de school hiervoor expliciet toestemming heeft gegeven via een ondertekende Attribute Release Policy.

Attributename Description Format Example
nlEduPersonRealId 1 Unencrypted version of the uid [userId]@[realm] pietjepukkelen@petteflatcollege
givenName First name string Pietje
nlEduPersonTussenvoegsels Tussenvoegsel string van
sn Surname string Pukkelen
mail Email address string pietjepuk@petteflatcollege.nl
initials Initals string P.
homePhone Phone number string +31791234567
mobile Mobile number string +31612345678
homePostalAddress Address Maximum of 6 lines each containing maximum 30 characters Petteflat 121e
2518PP Zoetermeer
nlEduPersonBirthDate Date of birth yyyymmdd 19801231
nlEduPersonProfile Opleidingsnaam voorafgegaan door CREBO[spatie].
Optioneel kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam
vrij tekstveld 2345 BOL_ICT.Gamedeveloper
nlEduPersonDepartment Department or sector string Techniek
nlEduPersonUnit Primaire klas/groep. Uniek binnen administratie / schooldomein string H2A
ou Klas of groep string H2A
nlEduPersonCohort Starting year string 2014
nlEduPersonProfileId ECK attribute
Indien een school meerdere administraties voert kan het administratienummer worden toegevoegd achter het @, zoals in het voorbeeld
leerlingnummer@administratienummer.schooldomein.nl 95312@1.kennisnet.nl
ocwILTRegistratiecode ILT Registrationcode
Conform bijlage I en II, behorende bij artikel 1 van de Regeling van de Minister OCW houdende vaststelling van de Elementcodetabel en Vakcodetabel VO en Volwasseneneducatie: nr. DUO/OND-2013/15135 M.
four digits 0011
ocwILTLeerjaar ILT cohort
Conform bijlage I en II, behorende bij artikel 1 van de Regeling van de Minister OCW houdende vaststelling van de Elementcodetabel en Vakcodetabel VO en Volwasseneneducatie: nr. DUO/OND-2013/15135 M.
1 digit 1

1 Let op: De versleutelde versie van dit attribuut wordt altijd doorgegeven (zie standaard attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.

Richtlijnen voor Identity Providers

De attributen die worden doorgegeven definiëren de identiteit van de gebruiker. Het is dan ook belangrijk dat dit correct en consistent gebeurt. Kennisnet heeft daarom hiervoor een aantal richtlijnen opgesteld.

Realm in het uid attribuut

Het attribuut uid vormt samen met het employeeNumber de basis van de unieke identiteit van een gebruiker binnen de hele keten. Diensten die zijn aangesloten bij Entree Federatie koppelen de voortgang of licenties van de gebruikeraan dit ID. Het is voor de gebruiker daarom uiterst belangrijk dat dit ID persistent is en blijft.

In het attribuut uid wordt een domein (of realm) meegegeven. Indien een school in de toekomst naar een andere systeem wil migreren is het belangrijk dat uid van gebruikers persistent blijft. Daarom moet als domein niet een systeemnaam, bijvoorbeeld pietjepukkelen@elonaam, gebruikt wordt maar een domein van de school, bijvoorbeeld pietjepukkelen@petteflatcollege.

Een Identity Provider waar meerdere onderwijsinstellingen gebruik van maken, moet in staat zijn om per aangesloten onderwijsinstelling een uniek domein door te geven in het uid attribuut.

BRIN nummer in het nlEduPersonHomeOrganizationId attribuut

Veel aangesloten diensten maken gebruik van schoollicenties. Het BRIN nummer in het nlEduPersonHomeOrganizationId attribuut wordt daarom aangewend om te controleren of een gebruiker toegang heeft. Tijdens een authenticatie valideert Entree Federatie het doorgegeven BRIN nummer.

  1. Een Identity Provider moet in staat zijn om BRIN nummers van zowel vier als zes karakters door te geven.
  2. Een Identity Provider waar meerdere onderwijsinstellingen gebruik van maken, moet in staat zijn om per aangesloten onderwijsinstelling een uniek BRIN nummer door te geven in het nlEduPersonHomeOrganizationId attribuut.