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

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Standard attributes)
(Standard attributes)
Regel 12: Regel 12:
   
 
==Standard attributes==
 
==Standard 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"
 
{| class="wikitable"
 
! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''
 
! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''

Versie van 24 okt 2016 om 21:27

Nl.gif Nederlands En.gif English


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:

  • Standard attributes
  • Additional attributes

For most Service Providers the set with standard 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.

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.

Standard 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 1 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

1 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

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
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
mobile Mobiel nummer vrij tekstveld +31612345678
homePostalAddress Adres Maximum 6 regels van elk 30 karakters Petteflat 121e
2518PP Zoetermeer
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
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
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 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.

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

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.

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

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.

  1. Een Identity Provider moet in staat zijn om BRIN nummers van zowel vier als zes karakters door te geven.
  2. 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.