KNF:AttributenOverzicht/en

Uit Kennisnet Developers Documentatie
< KNF:AttributenOverzicht
Versie door Oostmeijer01 (overleg | bijdragen) op 5 feb 2016 om 10:50 (Optional attributes)
Ga naar: navigatie, zoeken
Nl.gif Nederlands En.gif English

The Entree Federation uses attributes to authenticate and autorise users. These attributes contain information (for example a first name) about the user who wants to login at a Service Provider.
The set of used attributes consists of two types of attributes:

  • Mandatory attributes
  • Optional attributes

For most Service Providers the mandatory set of attributes will suffice to authenticate and autorise a user. However there might be situations in which a Service Provider may need more information about a user. In this case one or more optional attributes can be used.
The Identity Provider is responsible for the integrity of the content of the attributes. The Entree Federatie does not validate these values.

Mandatory attributes

On the left side of the table you find the attributes as they are provided by the Identity Provider.
On the right side of the table you find the attributes as they are passed on to the Service Provider by the Entree Federation.

Received from the Identity Provider Entree Federation Passed on to the Service Provider
Attributename Description Format Example Attributename Description Format Example
uid A users unique identifier, containing a username and realm 1 userId@realm johndoe@fairview  =>  uid The encrypted version of the combination of the username in the provided uid and employeenumber, followed by the realm in the provided uid. hash@realm qj7cks8qdz9ph54@fairview
employeeNumber Employee number string 140316
givenName First name string John  =>  givenName First name string John
sn Surname string Doe  =>2  sn Surname string Doe
mail Email address string johndoe@fairview.com  =>3 
eduPersonAffiliation Role student, employee, staff or affiliate student  =>  eduPersonAffiliation Role student, employee, staff or affiliate student
nlEduPersonHomeOrganizationId Unique identifier of the institution string (Entree Federation recommends using capitals) 01AB  =>  nlEduPersonHomeOrganizationId Unique identifier of the institution string 01AB
nlEduPersonHomeOrganization Name of the institution string Fairview College  =>  nlEduPersonHomeOrganization Name of the institution string Fairview College

1 Note: The value in the uid attribute has to be the same as the <sml:NameID> element when the SAML protocol is used for the connection to the Entree Federation.
2 Note: This attribute is received by the Entree Federation by default. During the implementation of the connection with the Entree Federation a Service Provider can choose to receive either the first name or the surname. When the Service Provider requires to receive both, schools have to sign an Attribute Release Policy.
3 Note: This attribute is received by the Entree Federation by default, but only passed in after the school has signed an Attribute Release Policy.

Optional attributes

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

Received from the Identity Provider Entree Federatie Passed on to the Service Provider
Attribuutname Description Format Example Attribuutname Description Format Example
uid A users unique identifier, containing a username and realm userId@realm johndoe@fairview  =>1  nlEduPersonRealId Unencrypted version of the uid [userId]@[realm] johndoe@fairview
nlEduPersonTussenvoegsels Tussenvoegsel string van  =>  nlEduPersonTussenvoegsels Tussenvoegsel string van
sn Surname string Doe  =>2  sn Surname string Doe
mail Email address string johndoe@fairview.com  =>3  mail Email address string johndoe@fairview.com
initials Initials string J.  =>  initials Initals string J.
homePhone Home phone number string +31791234567  =>  homePhone Home phone number string +31791234567
mobile Mobile number string +31612345678  =>  mobile Mobile number string +31612345678
homePostalAddress Home address Maximum 6 lines of 30 characters each Fairview Avenue 121e
2518PP Sweetlake
 =>  homePostalAddress Home address Fairview Avenue 121e
2518PP Sweetlake
nlEduPersonBirthDate Date of birth yyyymmdd 19801231  =>  nlEduPersonBirthDate Date of birth yyyymmdd 19801231
nlEduPersonProfile Name of course preceded by CREBO<space>. OPTIONAL BOL_ or BBL_ can be added to the name of the course string 2345 BOL_ICT.Gamedeveloper  =>  nlEduPersonProfile Name of course preceded by CREBO<space>. OPTIONAL BOL_ or BBL_ can be added to the name of the course string 2345 BOL_ICT.Gamedeveloper
nlEduPersonDepartment Department or sector string Science  =>  nlEduPersonDepartment Department or sector string Science
nlEduPersonUnit Primaire klas/groep. Uniek binnen administratie / schooldomein string H2A  =>  nlEduPersonUnit Primaire klas/groep. Uniek binnen administratie / schooldomein string H2A
ou Class string H2A  =>  ou Class string H2A
nlEduPersonCohort Startjaar string 2014  =>  nlEduPersonCohort Startjaar string 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  =>  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  =>  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  =>  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

1 Note: De versleutelde versie van dit attribuut wordt standaard doorgegeven (zie verplichte attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.
2 Note: 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.
3 Note: 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

An overview of used attribute release policies can be found at de support pagina van Kennisnet.