KNF:Attributen overzicht voor Service Providers: verschil tussen versies
(Nieuwe pagina aangemaakt met '__NOTOC__ {{Talen}} Om een gebruiker te authentiseren en vervolgens te autoriseren wordt binnen Entree Federatie gebruik gemaakt van attributen. Deze attributen bev...') |
|||
(72 tussenliggende versies door 2 gebruikers niet weergegeven) | |||
Regel 1: | Regel 1: | ||
− | __NOTOC__ |
||
{{Talen}} |
{{Talen}} |
||
+ | <br/> |
||
⚫ | |||
+ | __TOC__ |
||
+ | |||
⚫ | |||
De set van attributen bestaat uit twee typen attributen: |
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 |
+ | 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== |
==Standaard attributen== |
||
− | Hieronder staan de attributen |
+ | Hieronder staan de attributen die altijd door Entree Federatie worden doorgegeven aan de Service Provider. |
{| class="wikitable" |
{| class="wikitable" |
||
⚫ | |||
− | !colspan="4"|Doorgegeven aan de service provider |
||
|- |
|- |
||
+ | | 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 |
||
⚫ | |||
|- |
|- |
||
⚫ | |||
− | | uid || Uniek kenmerk van de gebruiker, bestaand uit een gebruikersnaam en omgeving '''<sup>1</sup>''' || userId@realm || pietjepuk@petteflat ||rowspan="2" style="color: white; background-color: grey; text-align:center;"| '''=>''' || rowspan="2"|uid || rowspan="2"|De versleutelde versie van de combinatie van de gebruikersnaam van het aangeleverde uid en het employeeNumber, gevolgd door de omgeving (realm) uit het aangeleverde uid || rowspan="2"|hash@realm || rowspan="2"|qj7cks8qdz9ph54@petteflat |
||
|- |
|- |
||
+ | | eduPersonAffiliation** || Rol || student, employee, staff of affiliate || student |
||
⚫ | |||
|- |
|- |
||
+ | | nlEduPersonHomeOrganizationId || BRIN nummer van de instelling || vrij tekstveld || 11ZZ03 |
||
− | | givenName || Voornaam || vrij tekstveld || Piet ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || givenName || Voornaam || vrij tekstveld || Piet |
||
|- |
|- |
||
+ | | nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College |
||
− | | sn || Achternaam || vrij tekstveld || Pukkelen ||style="color: white; background-color: grey; text-align:center;"| '''=><sup>2</sup>''' || sn || Achternaam || vrij tekstveld || Pukkelen |
||
|- |
|- |
||
+ | | eckId * || Uniek ECK pseudoniem voor leerling of docent '''<sup>2</sup>''' || tekstveld || <nowiki>https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa</nowiki> |
||
− | | eduPersonAffiliation || Rol || student, employee, staff of affiliate || student ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || eduPersonAffiliation || Rol || student, employee, staff of affiliate || student |
||
− | |- |
||
− | | nlEduPersonHomeOrganizationId || Brin nummer van de instelling || vrij tekstveld (KNF adviseert het gebruik van hoofdletters) || 01AB ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonHomeOrganizationId || Brin nummer van de instelling || vrij tekstveld || 01AB |
||
− | |- |
||
− | | nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College |
||
|} |
|} |
||
+ | * 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:''' Voor een SAML koppeling moet de waarde van het uid attribuut gelijk zijn aan de waarde van het <sml:NameID> veld.<br/> |
||
− | '''<sup>2</sup> Let op:''' Dit attribuut wordt standaard wel ontvangen door de Entree Federatie. 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== |
==Aanvullende attributen== |
||
− | Deze attributen worden alleen aan |
+ | 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" |
{| class="wikitable" |
||
⚫ | |||
− | !colspan="4"|Ontvangen van de identity provider |
||
− | !rowspan="2" style="color: white; background-color: grey;"|'''Entree Federatie''' |
||
− | !colspan="4"|Doorgegeven aan de service provider |
||
|- |
|- |
||
+ | | nlEduPersonRealId '''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepukkelen@petteflatcollege |
||
⚫ | |||
|- |
|- |
||
⚫ | |||
− | | uid || Uniek kenmerk van de gebruiker, bestaand uit een gebruikersnaam en omgeving || userId@realm || pietjepuk@petteflat ||style="color: white; background-color: grey; text-align:center;"| '''=><sup>1</sup>''' || nlEduPersonRealId || Onversleutelde versie van het uid || [userId]@[realm] || pietjepuk@petteflat |
||
|- |
|- |
||
− | + | | nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van |
|
|- |
|- |
||
− | + | | sn || Achternaam || vrij tekstveld || Pukkelen |
|
|- |
|- |
||
+ | | mail || E-mailadres || vrij tekstveld || pietjepukkelen@petteflatcollege.nl |
||
− | | mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl ||style="color: white; background-color: grey; text-align:center;"| '''=><sup>3</sup>''' || mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl |
||
|- |
|- |
||
− | + | | initials || Initalen || vrij tekstveld || P. |
|
|- |
|- |
||
+ | | nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231 |
||
− | | homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567 ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567 |
||
|- |
|- |
||
+ | | nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO[spatie].<br/>Optioneel kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper |
||
− | | mobile || Mobiel nummer || vrij tekstveld || +31612345678 ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || mobile || Mobiel nummer || vrij tekstveld || +31612345678 |
||
|- |
|- |
||
+ | | nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek |
||
− | | homePostalAddress || Adres || Maximum 6 regels van elk 30 karakters || Petteflat 121e <br/> 2518PP Zoetermeer ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || homePostalAddress || Adres || || Petteflat 121e <br/> 2518PP Zoetermeer |
||
|- |
|- |
||
+ | | nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A |
||
− | | nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231 ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231 |
||
|- |
|- |
||
+ | | ou || Klas of groep || vrij tekstveld || H2A |
||
− | | nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper |
||
|- |
|- |
||
+ | | nlEduPersonCohort || Startjaar || vrij tekstveld || 2014 |
||
− | | nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek |
||
|- |
|- |
||
⚫ | |||
− | | nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A |
||
|- |
|- |
||
⚫ | |||
− | | ou || Klas of groep || vrij tekstveld || H2A ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || ou || Klas of groep || vrij tekstveld || H2A |
||
|- |
|- |
||
+ | | digiDeliveryId || ECK digitaal afleveradres || tekstveld || ED8AE607-WI3N-414C-T87A-624E74S7T005 |
||
− | | nlEduPersonCohort || Startjaar || vrij tekstveld || 2014 ||style="color: white; background-color: grey; text-align:center;"| '''=>''' || nlEduPersonCohort || Startjaar || vrij tekstveld || 2014 |
||
|- |
|- |
||
+ | | nlEduPersonHomeOrganizationBranchId || Vestigingsnummer (BRIN 6) || String van 6 alfa-numerieke karakters || 11ZZ03 |
||
⚫ | | nlEduPersonProfileId || ECK |
||
|- |
|- |
||
+ | | nlEduPersonTargetedId || Badge ID || tekstveld || 12345678901234567890 |
||
⚫ | | ocwILTRegistratiecode || ILT Registratiecode |
||
− | |- |
||
⚫ | | ocwILTLeerjaar || ILT Leerjaar |
||
|} |
|} |
||
− | '''<sup>1</sup> Let op:''' De versleutelde |
+ | '''<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:''' Dit attribuut wordt standaard wel ontvangen door de Entree Federatie. 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/> |
||
− | '''<sup>3</sup> Let op:''' Dit attribuut wordt standaard wel ontvangen door de Entree Federatie, maar alleen doorgegeven als er een Attribute Release Policy is getekend door de school. |
||
==Attribute release policy== |
==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 is te vinden op [https://support.kennisnet.org/ |
+ | 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:Kennisnet Federatie]] |
||
[[Categorie:Entree Federatie]] |
[[Categorie:Entree Federatie]] |
Huidige versie van 22 nov 2023 om 16:51
Nederlands | 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 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 2 | 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 1 | 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 |
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 |
1 Let op: De versleutelde inhoud van dit attribuut wordt altijd doorgegeven in het attribuut uid (zie standaard attributen).
2 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.