KNF:Attributen overzicht voor Service Providers: verschil tussen versies

Huidige versie van 22 nov 2023 om 16:51

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 wilt inloggen.
De set van attributen bestaat uit twee typen attributen:

Standaard attributen: worden door alle Service Providers ontvangen
Aanvullende attributen: worden alleen ontvangen na expliciete toestemming van de onderwijsinstelling

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.

Standaard attributen

Hieronder staan de attributen die altijd door Entree Federatie worden doorgegeven aan de Service Provider.

Attribuutnaam	Beschrijving	Formaat	Voorbeeld
uid	Uniek ID van de gebruiker. Dit is een versleutelde versie van de gebruikersnaam en het employeeNumber, gevolgd door de omgeving (realm)	hash@realm	qj7cks8qdz9ph54@petteflatcollege
givenName	Voornaam	vrij tekstveld	Pietje
eduPersonAffiliation**	Rol	student, employee, staff of affiliate	student
nlEduPersonHomeOrganizationId	BRIN nummer van de instelling	vrij tekstveld	11ZZ03
nlEduPersonHomeOrganization	Naam van de instelling	vrij tekstveld	Petteflat College
eckId *	Uniek ECK pseudoniem voor leerling of docent ²	tekstveld	https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa

* Als aangesloten dienstaanbieder heeft u ook de mogelijkheid om ECK iD’s via Entree Federatie te ontvangen. Voorwaarden en aanmelden
Voor meer informatie over het ECK iD: https://www.eck-id.nl/implementatie/documentatie

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
nlEduPersonProfileId	ECK keten-ID 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
nlEduPersonTussenvoegsels	Tussenvoegsel	vrij tekstveld	van
sn	Achternaam	vrij tekstveld	Pukkelen
mail	E-mailadres	vrij tekstveld	pietjepukkelen@petteflatcollege.nl
initials	Initalen	vrij tekstveld	P.
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
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

¹ Let op: De versleutelde inhoud van dit attribuut wordt altijd doorgegeven in het attribuut uid (zie standaard attributen).
² Voor meer informatie over het ECK-iD: https://www.eck-id.nl/

Attribute release policy

Door het ondertekenen van een Attribute Release Policy geeft een school toestemming om bepaalde aanvullende attributen aan een specifieke Service Provider door te geven. Een overzicht van attribute release policies die al gebruikt worden is te vinden op de support pagina van Kennisnet.

Rollen eduPersonAffiliation

Hieronder beschrijving van de verschillende rollen die gebruikt worden binnen Entree Federatie.

De rol student is voor studenten.
De rol employee is voor docenten.
De rol staff is voor onderwijspersoneel.
De rol affiliate wordt gebruikt voor Entree Account gebruikers.

@@ Regel 5: / Regel 5: @@
 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 wilt inloggen.<br/>
 De set van attributen bestaat uit twee typen attributen:
-*Standaard attributen
+*Standaard attributen: worden door alle Service Providers ontvangen
-*Aanvullende attributen
+*Aanvullende attributen: worden alleen ontvangen na expliciete toestemming van de onderwijsinstelling
 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.
@@ Regel 16: / Regel 16: @@
 | uid || Uniek ID van de gebruiker. Dit is een versleutelde versie van de gebruikersnaam en het employeeNumber, gevolgd door de omgeving (realm) || hash@realm || qj7cks8qdz9ph54@petteflatcollege
 |-
-| givenName&nbsp;'''<sup>1</sup>''' || Voornaam || vrij tekstveld || Pietje
+| givenName || Voornaam || vrij tekstveld || Pietje
 |-
+| eduPersonAffiliation** || Rol || student, employee, staff of affiliate || student
-| sn&nbsp;'''<sup>1</sup>''' || Achternaam || vrij tekstveld || Pukkelen
 |-
+| nlEduPersonHomeOrganizationId || BRIN nummer van de instelling || vrij tekstveld || 11ZZ03
-| eduPersonAffiliation || Rol || student, employee, staff of affiliate || student
-|-
-| nlEduPersonHomeOrganizationId || Brin nummer van de instelling || vrij tekstveld || 11ZZ03
 |-
 | nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College
+|-
+| eckId * || Uniek ECK pseudoniem voor leerling of docent&nbsp;'''<sup>2</sup>''' || tekstveld || <nowiki>https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa</nowiki>
 |}
+ * Als aangesloten dienstaanbieder heeft u ook de mogelijkheid om ECK iD’s via Entree Federatie te ontvangen. [https://www.kennisnet.nl/entree-federatie/aanmelden/ Voorwaarden en aanmelden]<br/>Voor meer informatie over het ECK iD: https://www.eck-id.nl/implementatie/documentatie
-'''<sup>1</sup> Let op:''' Bij de implementatie van de koppeling kan de Service Provider ervoor kiezen om óf de voornaam óf de achternaam te ontvangen. Als de Service Provider zowel de voornaam als de achternaam wil ontvangen dan moet hiervoor een Attribute Release Policy worden ondertekend door de school.<br/>
 ==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 ondertekende [https://support.kennisnet.org/Knowledgebase/Article/View/511 Attribute Release Policy].
 {| class="wikitable"
 ! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
@@ Regel 35: / Regel 35: @@
 | nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepukkelen@petteflatcollege
 |-
+| nlEduPersonProfileId || ECK keten-ID<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
-| givenName&nbsp;'''<sup>2</sup>''' || Voornaam || vrij tekstveld || Pietje
 |-
 | nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
 |-
-| sn&nbsp;'''<sup>2</sup>''' || Achternaam || vrij tekstveld || Pukkelen
+| sn || Achternaam || vrij tekstveld || Pukkelen
 |-
-| mail || Email adres || vrij tekstveld || pietjepukkelen@petteflatcollege.nl
+| mail || E-mailadres || vrij tekstveld || pietjepukkelen@petteflatcollege.nl
 |-
 | initials || Initalen || vrij tekstveld || P.
-|-
-| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
-|-
-| mobile || Mobiel nummer || vrij tekstveld || +31612345678
 |-
 | nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
@@ Regel 60: / Regel 56: @@
 |-
 | 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> Let op:''' De versleutelde inhoud van dit attribuut wordt altijd doorgegeven in het attribuut uid (zie standaard attributen).<br/>
+'''<sup>2</sup>''' Voor meer informatie over het ECK-iD: https://www.eck-id.nl/
-'''<sup>2</sup> Let op:''' Bij de implementatie van de koppeling kan de Service Provider ervoor kiezen om óf de voornaam óf de achternaam te ontvangen. Als de Service Provider zowel de voornaam als de achternaam wil ontvangen dan moet hiervoor een Attribute Release Policy worden ondertekend door de school.
 ==Attribute release policy==
 Door het ondertekenen van een Attribute Release Policy geeft een school toestemming om bepaalde aanvullende attributen aan een specifieke Service Provider door te geven.
-Een voorbeeld van een standaard [https://support.kennisnet.org/index.php?/Knowledgebase/Article/View/280/0/standaard-invulbaar-arp-formulier-verzoek-uitbreiding-attributen Attribute Release Policy]. Een overzicht van attribute release policies die al gebruikt worden is te vinden op [https://support.kennisnet.org/Knowledgebase/Article/View/511/0/er-zijn-meer-attributen-van-gebruikers-nodig-wat-nu de support pagina van Kennisnet].
+Een overzicht van attribute release policies die al gebruikt worden is te vinden op [https://support.kennisnet.org/display/FAQ/Federatie+FAQ de support pagina van Kennisnet].
+==Rollen eduPersonAffiliation==
+Hieronder beschrijving van de verschillende rollen die gebruikt worden binnen Entree Federatie.
+* De rol student is voor studenten.
+* De rol employee is voor docenten.
+* De rol staff is voor onderwijspersoneel.
+* De rol affiliate wordt gebruikt voor Entree Account gebruikers.
 [[Categorie:Entree Federatie]]
-[[Categorie:Entree Federatie Service Provider]]

KNF:Attributen overzicht voor Service Providers: verschil tussen versies

Huidige versie van 22 nov 2023 om 16:51

Inhoud

Standaard attributen

Aanvullende attributen

Attribute release policy

Rollen eduPersonAffiliation

Navigatiemenu

Zoeken