KNF:Attributen overzicht voor Identity Providers: verschil tussen versies

Versie van 24 okt 2016 15:30

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 ¹	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

¹ 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.

Attribuutnaam	Beschrijving	Formaat	Voorbeeld
nlEduPersonRealId ¹	Onversleutelde versie van het uid	[userId]@[realm]	pietjepukkelen@petteflatcollege
givenName	Voornaam	vrij tekstveld	Pietje
nlEduPersonTussenvoegsels	Tussenvoegsel	vrij tekstveld	van
sn	Achternaam	vrij tekstveld	Pukkelen
mail	Email adres	vrij tekstveld	pietjepuk@petteflatcollege.nl
initials	Initalen	vrij tekstveld	P.
homePhone	Telefoonnummer (vast)	vrij tekstveld	+31791234567
mobile	Mobiel nummer	vrij tekstveld	+31612345678
homePostalAddress	Adres	Maximum 6 regels van elk 30 karakters	Petteflat 121e 2518PP Zoetermeer
nlEduPersonBirthDate	Geboortedatum	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	Afdeling of sector	vrij tekstveld	Techniek
nlEduPersonUnit	Primaire klas/groep. Uniek binnen administratie / schooldomein	vrij tekstveld	H2A
ou	Klas of groep	vrij tekstveld	H2A
nlEduPersonCohort	Startjaar	vrij tekstveld	2014
nlEduPersonProfileId	ECK attribuut 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 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
ocwILTLeerjaar	ILT Leerjaar 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

¹ 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

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.

Een Identity Provider moet in staat zijn zowel 4-cijferige als 6-cijferige BRIN nummers door te geven.
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.

@@ Regel 78: / Regel 78: @@
 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===
-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 gebruiken dit ID om voortgang of licenties van de gebruiker aan te koppelen. Het is daarom belangrijk dat dit ID persistent is.
+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.