KNF:Attributen overzicht voor Identity Providers: verschil tussen versies

Huidige versie van 21 nov 2023 om 11:03

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 (ook wel Service Provider genoemd) wilt inloggen. De dienst gebruikt deze gegevens om te bepalen of de gebruiker toegang krijgt.
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 domein	userId@realm	pietjepukkelen@petteflatcollege.nl
Name ID	zelfde waarde als uid	userId@realm	pietjepukkelen@petteflatcollege.nl
employeeNumber	Leerlingnummer	vrij tekstveld	123456
givenName	Voornaam	vrij tekstveld	Pietje
sn	Achternaam	vrij tekstveld	Pukkelen
eduPersonAffiliation	Rol	student, employee, staff of affiliate	student
nlEduPersonHomeOrganizationId	BRIN van de instelling	4 of 6 karakters	11ZZ03
nlEduPersonHomeOrganization	Naam van de instelling	vrij tekstveld	Petteflat College

Het formaat van dit attribuut moet als volgt zijn userid@realm, wat dus sterk lijkt op een mailadres. Belangrijk is dat dit attribuut niet wijzigt omdat dit de unieke identifier is waarmee de gebruiker bekend is binnen de keten en bij de aangesloten diensten van Entree Federatie.

Aanvullende attributen

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

Attribuutnaam	Beschrijving	Formaat	Voorbeeld
nlEduPersonProfileId	ECK keten-ID 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
eckId	Uniek ECK pseudoniem voor leerling of docent ¹	tekstveld	https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa
initials	Initalen	vrij tekstveld	P.
nlEduPersonTussenvoegsels	Tussenvoegsel	vrij tekstveld	van
mail	E-mailadres	vrij tekstveld	pietjepukkelen@petteflatcollege.nl
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	Groep	vrij tekstveld	H2A
nlEduPersonCohort	Startjaar	vrij tekstveld	2014
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
digiDeliveryId	ECK digitaal afleveradres	tekstveld	ED8AE607-WI3N-414C-T87A-624E74S7T005
nlEduPersonHomeOrganizationBranchId	Vestigingsnummer (BRIN 6)	String van 6 alfa-numerieke karakters	11ZZ03
nlEduPersonTargetedId	Badge ID	tekstveld	12345678901234567890

¹ Voor meer informatie over het ECK-iD: https://www.eck-id.nl/

Het nlEduPersonRealId attribuut

In sommige gevallen kan een dienstleverancier ook vragen om het nlEduPersonRealId. In dit attribuut wordt de waarde die de Identity Provider in het Name ID element naar Entree Federatie stuurt, tijdens de authenticatie door de Entree Federatie applicatie gekopieerd. De Identity Provider hoeft het nlEduPersonRealId dus niet zelf te configureren en naar Entree Federatie op te sturen, daarom staat het attribuut ook niet in het bovenstaande overzicht.

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 Name ID element

Het element Name ID 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 gebruiker aan dit ID. Het is voor de gebruiker daarom uiterst belangrijk dat dit ID persistent is en blijft.

In het element Name ID wordt een domein (of realm) meegegeven. Indien een school in de toekomst naar een andere systeem wilt migreren is het belangrijk dat het Name Id van gebruikers persistent blijft. Daarom moet als realm niet een systeemnaam worden gebruikt, bijvoorbeeld pietjepukkelen@elonaam, 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 Name ID element.

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 om BRIN nummers van zowel vier als zes karakters 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 3: / Regel 3: @@
 __TOC__
-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 (ook wel Service Provider genoemd) wil inloggen. De dienst gebruikt deze gegevens om te bepalen of de gebruiker toegang krijgt.<br/>
+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 (ook wel Service Provider genoemd) wilt inloggen. De dienst gebruikt deze gegevens om te bepalen of de gebruiker toegang krijgt.<br/>
 De set van attributen bestaat uit twee typen attributen:
 *Standaard attributen
@@ Regel 16: / Regel 16: @@
 ! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
 |-
-| uid || Uniek kenmerk van de gebruiker, bestaand uit een gebruikersnaam en omgeving&nbsp;'''<sup>1</sup>''' || userId@realm || pietjepukkelen@petteflatcollege
+| uid * || Uniek kenmerk van de gebruiker, bestaand uit een gebruikersnaam en domein || userId@realm || pietjepukkelen@petteflatcollege.nl
+|-
+| Name ID || zelfde waarde als uid || userId@realm || pietjepukkelen@petteflatcollege.nl
 |-
 | employeeNumber || Leerlingnummer || vrij tekstveld || 123456
@@ Regel 24: / Regel 26: @@
 | sn || Achternaam || vrij tekstveld || Pukkelen
 |-
-| eduPersonAffiliation || Rol || student, employee, staff of affiliate || student
+| eduPersonAffiliation || Rol || ''student'', ''employee'', ''staff'' of ''affiliate'' || student
 |-
-| nlEduPersonHomeOrganizationId || Brin nummer van de instelling || 4 of 6 karakters || 11ZZ03
+| nlEduPersonHomeOrganizationId || BRIN van de instelling || 4 of 6 karakters || 11ZZ03
 |-
 | nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College
 |}
-'''<sup>1</sup> Let op:''' Voor een SAML koppeling moet de waarde van het uid attribuut gelijk zijn aan de waarde van het ''<saml:NameID>'' veld.<br/>
+* Het formaat van dit attribuut moet als volgt zijn userid@realm, wat dus sterk lijkt op een mailadres. Belangrijk is dat dit attribuut niet wijzigt omdat dit de unieke identifier is waarmee de gebruiker bekend is binnen de keten en bij de aangesloten diensten van Entree Federatie.
 ==Aanvullende attributen==
-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 ondertekend [https://support.kennisnet.org/Knowledgebase/Article/View/511 Attribute Release Policy] formulier.
 {| class="wikitable"
 ! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
 |-
+| nlEduPersonProfileId || ECK keten-ID 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
-| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepukkelen@petteflatcollege
 |-
+| eckId || Uniek ECK pseudoniem voor leerling of docent&nbsp;'''<sup>1</sup>''' || tekstveld || <nowiki>https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa</nowiki>
-| 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
+| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
-|-
-| mobile || Mobiel nummer || vrij tekstveld || +31612345678
 |-
+| mail || E-mailadres || vrij tekstveld || pietjepukkelen@petteflatcollege.nl
-| homePostalAddress || Adres || Maximum 6 regels van elk 30 karakters || Petteflat 121e <br/> 2518PP Zoetermeer
 |-
 | nlEduPersonBirthDate || Geboortedatum || 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
@@ Regel 63: / Regel 58: @@
 | nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A
 |-
-| ou || Klas of groep || vrij tekstveld || H2A
+| ou || Groep || vrij tekstveld || H2A
 |-
 | nlEduPersonCohort || Startjaar || vrij tekstveld || 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
 |-
 | 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
 |-
 | 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
+|-
+| digiDeliveryId || ECK digitaal afleveradres || tekstveld  || ED8AE607-WI3N-414C-T87A-624E74S7T005
+|-
+| nlEduPersonHomeOrganizationBranchId || Vestigingsnummer (BRIN 6) || String van 6 alfa-numerieke karakters || 11ZZ03
+|-
+| nlEduPersonTargetedId || Badge ID || tekstveld  || 12345678901234567890
 |}
+'''<sup>1</sup>''' Voor meer informatie over het ECK-iD: https://www.eck-id.nl/<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/>
+===Het nlEduPersonRealId attribuut===
+In sommige gevallen kan een dienstleverancier ook vragen om het ''nlEduPersonRealId''. In dit attribuut wordt de waarde die de Identity Provider in het ''Name ID'' element naar Entree Federatie stuurt, tijdens de authenticatie door de Entree Federatie applicatie gekopieerd. De Identity Provider hoeft het ''nlEduPersonRealId'' dus '''niet''' zelf te configureren en naar Entree Federatie op te sturen, daarom staat het attribuut ook niet in het bovenstaande overzicht.
 ==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===
+===Realm in het ''Name ID'' element===
-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.
+Het element ''Name ID'' 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 gebruiker aan 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.
+In het element ''Name ID'' wordt een domein (of realm) meegegeven. Indien een school in de toekomst naar een andere systeem wilt migreren is het belangrijk dat het ''Name Id'' van gebruikers persistent blijft. Daarom moet als realm niet een systeemnaam worden gebruikt, bijvoorbeeld ''pietjepukkelen@elonaam'', 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.
+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 ''Name ID'' element.
 ===BRIN nummer in het ''nlEduPersonHomeOrganizationId'' attribuut===
@@ Regel 90: / Regel 92: @@
 [[Categorie:Entree Federatie]]
-[[Categorie:Entree Federatie Identity Provider]]