Huidige versie van 8 feb 2021 om 09:38

Entree Federation: Overview attributes for Identity Providers

To authenticate and subsequently authorize a user the Entree Federation uses attributes. These attributes contain information (for example a firstname) about the user who wants access to a connected Service Provider.
There are two types of attributes used within the context of Entree Federation:

Default attributes
Additional attributes

For most Service Providers the set with default attributes will suffice to authenticate and authorize users. However there are situations in which a Service Provider requires more information about a user. In this case one or more additional attributes can be used.

In order to enable the users to gain access to all connected Service Providers an Identity Provider has to support both the default attributes and the additional attributes.

Default attributes

In this table you can find the attributes that an Identity Provider always has to pass on to Entree Federation.

Attributename	Description	Format	Example
uid	Unique ID for the user, consisting of a username and a realm ¹	userId@realm	pietjepukkelen@petteflatcollege
employeeNumber	Studentnumber	string	140136
givenName	First name	string	Pietje
sn	Surname	string	Pukkelen
eduPersonAffiliation	Role	student, employee, staff or affiliate	student
nlEduPersonHomeOrganizationId	BRIN code of the institution	4 or 6 characters	11ZZ03
nlEduPersonHomeOrganization	Name of the institution	string	Petteflat College

¹ Attention: When using the SAML protocol the value of uid attribute has to be the same as the value of the <saml:NameID> field.

Additional attributes

These attributes will only passed on to a Service Provider after the school has given explicit permission by signing an Attribute Release Policy form.

Attributename	Description	Format	Example
nlEduPersonProfileId	ECK attribute If a school has multiple administrations the administrationnumber can be added after the @ as in the example	studentnumber@administrationnumber.schooldomain.nl	95312@1.kennisnet.nl
eckId	Unique ECK pseudonym for students and teachers ¹	string	https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa
initials	Initials	string	P.
nlEduPersonTussenvoegsels	Insertion	string	van
mail	Email address	string	pietjepukkelen@petteflatcollege.nl
homePhone	Phone number	string	+31791234567
mobile	Mobile number	string	+31612345678
nlEduPersonBirthDate	Date of birth	yyyymmdd	19801231
nlEduPersonProfile	Name of study preceded by CREBO<space>. Optionally BOL_ or BBL_ can be added at the beginning	string	2345 BOL_ICT.Gamedeveloper
nlEduPersonDepartment	Department or sector	string	Techniek
nlEduPersonUnit	Primary class or group. Unique within the school administration or domain	string	H2A
ou	Class or group	string	H2A
nlEduPersonCohort	Starting year	string	2014
ocwILTRegistratiecode	ILT Registrationcode In accordance with annex I and II, corresponding to Article 1 of the Regulation of the Minister of OCW containing the determination of the elementcode table and studycode table for secondary and adult education: No DUO / OND-2013/15135 M.	four digits	0011
ocwILTLeerjaar	ILT cohort In accordance with annex I and II, corresponding to Article 1 of the Regulation of the Minister of OCW containing the determination of the elementcode table and studycode table for secondary and adult education: nr. DUO/OND-2013/15135 M.	1 digit	1
digiDeliveryId	ECK digital delivery address	string	ED8AE607-WI3N-414C-T87A-624E74S7T005
nlEduPersonHomeOrganizationBranchId	Establishment number (BRIN 6)	String of 6 alpha-numeric characters	11ZZ03
preferredLanguage	Preferred Language	Language code (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)	nl
country	Country	Country code (https://en.wikipedia.org/wiki/ISO_3166-1)	NL

¹ For more information on the ECK-iD: https://www.eck-id.nl/

The nlEduPersonRealId attribute

In some cases a Service Provider request the nlEduPersonRealId attribute. During an authentication the Entree Federation application will copy the value of the uid attribitute that is sent by the Identity Provider into the nlEduPersonRealId attribute. Therefore the Identity Provider does not need to configure the nlEduPersonRealId and it is not listed in the table above.

Guidelines for Identity Providers

The user's identity is defined by the attributes that are passed down. It's important that this happens correctly and consistently. Therefore Kennisnet has set up a number of guidelines.

Realm in the uid attribute

The uid-attribute combined with the employeeNumber are the basis of the unique identity of the user within the system. Service Providers who are connected to Entree Federation use this ID to monitor progress or link licenses to it. From a users perspective therefor it is of the atmost importance that this ID is persistent.

The uid-attribute also contains a domain (or realm). If a school wants to change to another type of Identity Provider it is important that the uid of its users stay persistent. Therefor the domain should not contain the name of a system, e.g. pietjepukkelen@elonaam, but the domain should be linked to the school, e.g. pietjepukkelen@petteflatcollege.

If an Identity Provider is used by multiple educational institutions, the Identity Provider has to be able to pass on a unique domain per educational institution within the uid-attribute.

BRIN number in the nlEduPersonHomeOrganizationId attribute

Many of the connected Service Providers use schoollicenses. In those cases the BRIN number in the nlEduPersonHomeOrganizationId-attribute is used to authorize the user. Entree Federation will validate the received BRIN number against the registered BRIN number.

An Identity Provider must be able to pass on a BRIN number containing either four or six characters.
If an Identity Provider is used by multiple educational institutions, the Identity Provider has to be able to pass on a unique BRIN number per educational institution within the nlEduPersonHomeOrganizationId-attribute.

@@ Regel 1: / Regel 1: @@
+{{PageTitleCustom|title=Overview attributes for Identity Providers|name=Entree Federation|image=true|imageurl=KNF:Hoofdpagina/en}}
-{{Talen}}
 <br/>
 __TOC__
+To authenticate and subsequently authorize a user the Entree Federation uses attributes. These attributes contain information (for example a firstname) about the user who wants access to a connected Service Provider.<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 wil inloggen.<br/>
+There are two types of attributes used within the context of Entree Federation:
-De set van attributen bestaat uit twee typen attributen:
+*Default attributes
-*Standaard attributen
+*Additional attributes
-*Aanvullende attributen
+For most Service Providers the set with default attributes will suffice to authenticate and authorize users. However there are situations in which a Service Provider requires more information about a user. In this case one or more additional attributes can be used.
-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.
+In order to enable the users to gain access to all connected Service Providers an Identity Provider has to support both the default attributes and the additional attributes.
-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==
+==Default attributes==
-Hieronder staan de attributen die altijd door de Identity Provider aan Entree Federatie moeten worden doorgegeven
+In this table you can find the attributes that an Identity Provider always has to pass on to Entree Federation.
 {| class="wikitable"
-! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
+! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''
 |-
-| uid || Uniek kenmerk van de gebruiker, bestaand uit een gebruikersnaam en omgeving&nbsp;'''<sup>1</sup>''' || userId@realm || pietjepukkelen@petteflatcollege
+| uid || Unique ID for the user, consisting of a username and a realm&nbsp;'''<sup>1</sup>''' || userId@realm || pietjepukkelen@petteflatcollege
 |-
-| employeeNumber || Leerlingnummer || vrij tekstveld || 140136
+| employeeNumber || Studentnumber || string || 140136
 |-
-| givenName || Voornaam || vrij tekstveld || Pietje
+| givenName || First name || string || Pietje
 |-
-| sn || Achternaam || vrij tekstveld || Pukkelen
+| sn || Surname || string || Pukkelen
 |-
-| eduPersonAffiliation || Rol || student, employee, staff of affiliate || student
+| eduPersonAffiliation || Role || student, employee, staff or affiliate || student
 |-
-| nlEduPersonHomeOrganizationId || Brin nummer van de instelling || 4 of 6 karakters || 11ZZ03
+| nlEduPersonHomeOrganizationId || BRIN code of the institution || 4 or 6 characters || 11ZZ03
 |-
-| nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College
+| nlEduPersonHomeOrganization || Name of the institution || string || 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/>
+'''<sup>1</sup> Attention:''' When using the SAML protocol the value of uid attribute has to be the same as the value of the ''<saml:NameID>'' field.<br/>
+==Additional attributes==
-==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].
+These attributes will only passed on to a Service Provider after the school has given explicit permission by signing an  [https://support.kennisnet.org/Knowledgebase/Article/View/511/0/er-zijn-meer-attributen-van-gebruikers-nodig-wat-nu Attribute Release Policy] form.
 {| class="wikitable"
-! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
+! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''
 |-
+| nlEduPersonProfileId || ECK attribute<br/>If a school has multiple administrations the administrationnumber can be added after the @ as in the example || studentnumber@administrationnumber.schooldomain.nl || 95312@1.kennisnet.nl
-| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepukkelen@petteflatcollege
 |-
+| eckId || Unique ECK pseudonym for students and teachers&nbsp;'''<sup>1</sup>''' || string || <nowiki>https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa</nowiki>
-| givenName || Voornaam || vrij tekstveld || Pietje
 |-
-| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
+| initials || Initials || string || P.
 |-
+| nlEduPersonTussenvoegsels || Insertion || string || van
-| sn || Achternaam || vrij tekstveld || Pukkelen
 |-
-| mail || Email adres || vrij tekstveld || pietjepuk@petteflatcollege.nl
+| mail || Email address || string || pietjepukkelen@petteflatcollege.nl
 |-
-| initials || Initalen || vrij tekstveld || P.
+| homePhone || Phone number || string || +31791234567
 |-
-| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
+| mobile || Mobile number || string || +31612345678
 |-
+| nlEduPersonBirthDate || Date of birth|| yyyymmdd || 19801231
-| mobile || Mobiel nummer || vrij tekstveld || +31612345678
 |-
+|  nlEduPersonProfile || Name of study preceded by ''CREBO<space>''.<br/>Optionally ''BOL_'' or ''BBL_'' can be added at the beginning || string || 2345 BOL_ICT.Gamedeveloper
-| homePostalAddress || Adres || Maximum 6 regels van elk 30 karakters || Petteflat 121e <br/> 2518PP Zoetermeer
 |-
+| nlEduPersonDepartment || Department or sector || string || Techniek
-| nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
 |-
+| nlEduPersonUnit || Primary class or group. Unique within the school administration or domain || string || H2A
-|  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
+| ou || Class or group || string || H2A
 |-
+| nlEduPersonCohort || Starting year || string || 2014
-| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A
 |-
+| ocwILTRegistratiecode || ILT Registrationcode<br/>''In accordance with annex I and II, corresponding to Article 1 of the Regulation of the Minister of OCW containing the determination of the elementcode table and studycode table for secondary and adult education: No DUO / OND-2013/15135 M.'' || four digits || 0011
-| ou || Klas of groep || vrij tekstveld || H2A
 |-
+| ocwILTLeerjaar || ILT cohort<br/>''In accordance with annex I and II, corresponding to Article 1 of the Regulation of the Minister of OCW containing the determination of the elementcode table and studycode table for secondary and adult education: nr. DUO/OND-2013/15135 M.'' || 1 digit || 1
-| nlEduPersonCohort || Startjaar || vrij tekstveld || 2014
 |-
+| digiDeliveryId || ECK digital delivery address || string|| ED8AE607-WI3N-414C-T87A-624E74S7T005
-| 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
 |-
+| nlEduPersonHomeOrganizationBranchId || Establishment number (BRIN 6) || String of 6 alpha-numeric characters || 11ZZ03
-| 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
 |-
+| preferredLanguage || Preferred Language || Language code (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) || nl
-| 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
+|-
+| country || Country || Country code (https://en.wikipedia.org/wiki/ISO_3166-1) || NL
 |}
+'''<sup>1</sup>''' For more information on the 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/>
+===The nlEduPersonRealId attribute===
+In some cases a Service Provider request the ''nlEduPersonRealId'' attribute. During an authentication the Entree Federation application will copy the value of the ''uid'' attribitute that is sent by the Identity Provider into the ''nlEduPersonRealId'' attribute. Therefore the Identity Provider does '''not''' need to configure the ''nlEduPersonRealId'' and it is not listed in the table above.
+==Guidelines for Identity Providers==
+The user's identity is defined by the attributes that are passed down. It's important that this happens correctly and consistently. Therefore Kennisnet has set up a number of guidelines.
+===Realm in the ''uid'' attribute===
-==Richtlijnen voor Identity Providers==
+The ''uid''-attribute combined with the ''employeeNumber'' are the basis of the unique identity of the user within the system. Service Providers who are connected to Entree Federation use this ID to monitor progress or link licenses to it. From a users perspective therefor it is of the atmost importance that this ID is persistent.
-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.
+The ''uid''-attribute also contains a domain (or realm). If a school wants to change to another type of Identity Provider it is important that the ''uid'' of its users stay persistent. Therefor the domain should not contain the name of a system, e.g. pietjepukkelen@elonaam, but the domain should be linked to the school, e.g. pietjepukkelen@petteflatcollege.
+If an Identity Provider is used by multiple educational institutions, the Identity Provider has to be able to pass on a unique domain per educational institution within the ''uid''-attribute.
-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===
+===BRIN number in the ''nlEduPersonHomeOrganizationId'' attribute===
-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.
+Many of the connected Service Providers use schoollicenses. In those cases the BRIN number in the ''nlEduPersonHomeOrganizationId''-attribute is used to authorize the user. Entree Federation will validate the received BRIN number against the registered BRIN number.
-# Een Identity Provider moet in staat zijn om BRIN nummers van zowel vier als zes karakters door te geven.
+# An Identity Provider must be able to pass on a BRIN number containing either four or six characters.
-# 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.
+# If an Identity Provider is used by multiple educational institutions, the Identity Provider has to be able to pass on a unique BRIN number per educational institution within the ''nlEduPersonHomeOrganizationId''-attribute.
 [[Categorie:Entree Federatie]]
-[[Categorie:Entree Federatie Identity Provider]]

KNF:Attributen overzicht voor Identity Providers/en: verschil tussen versies