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

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Regel 29: Regel 29:
   
 
==Additional attributes==
 
==Additional attributes==
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].
+
The Service Provider will only receive these attributes when the school has given explicit permission by signing an [https://support.kennisnet.org/index.php?/Knowledgebase/Article/View/226/0/wat-is-een-arp Attribute Release Policy] form.
 
{| class="wikitable"
 
{| class="wikitable"
! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
+
! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''
 
|-
 
|-
 
| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepuk@petteflat
 
| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepuk@petteflat
 
|-
 
|-
| givenName&nbsp;'''<sup>2</sup>''' || Voornaam || vrij tekstveld || Piet
+
| givenName&nbsp;'''<sup>2</sup>''' || First name|| string || Piet
 
|-
 
|-
| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
+
| nlEduPersonTussenvoegsels || Tussenvoegsel || string || van
 
|-
 
|-
| sn&nbsp;'''<sup>2</sup>''' || Achternaam || vrij tekstveld || Pukkelen
+
| sn&nbsp;'''<sup>2</sup>''' || Surname|| string || Pukkelen
 
|-
 
|-
| mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl
+
| mail || Email adres || string || pietjepuk@petteflat.nl
 
|-
 
|-
| initials || Initalen || vrij tekstveld || P.
+
| initials || Initials || string || P.
 
|-
 
|-
| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
+
| homePhone || Telefoonnummer (vast) || string || +31791234567
 
|-
 
|-
| mobile || Mobiel nummer || vrij tekstveld || +31612345678
+
| mobile || Mobiel nummer || string || +31612345678
 
|-
 
|-
 
| homePostalAddress || Adres || || Petteflat 121e <br/> 2518PP Zoetermeer
 
| homePostalAddress || Adres || || Petteflat 121e <br/> 2518PP Zoetermeer
 
|-
 
|-
| nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
+
| nlEduPersonBirthDate || Date of birth|| yyyymmdd || 19801231
 
|-
 
|-
| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper
+
| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || string || 2345 BOL_ICT.Gamedeveloper
 
|-
 
|-
| nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek
+
| nlEduPersonDepartment || Department or sector || string || Techniek
 
|-
 
|-
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A
+
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || string || H2A
 
|-
 
|-
| ou || Klas of groep || vrij tekstveld || H2A
+
| ou || Klas of groep || string || H2A
 
|-
 
|-
| nlEduPersonCohort || Startjaar || vrij tekstveld || 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 attribute<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 (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<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.'' || four digit-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<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.'' || one digit|| 1
 
|}
 
|}
'''<sup>1</sup> Let op:''' De versleutelde versie van dit attribuut wordt standaard doorgegeven (zie verplichte attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.<br/>
+
'''<sup>1</sup> Attention:''' De versleutelde versie van dit attribuut wordt standaard doorgegeven (zie verplichte attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.<br/>
'''<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.
+
'''<sup>2</sup> Attention:''' 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==
 
==Attribute release policy==

Versie van 24 okt 2016 20:48

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.

Standard attributes

In this table you can find the attributes that a Service Provider will always receive from Entree Federation.

Attributename Description Format Example
uid Unique ID for the user. This is a encrypted version of the username and employeeNumber, followed by the realm hash@realm qj7cks8qdz9ph54@petteflat
givenName 1 First name string Piet
sn 1 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: During the implementation of the coupling the Service Provider can choose to receive either the first name or the surname. If the Service Provider prefers to receive both names the school has to sign a Attribute Release Policy form.

Additional attributes

The Service Provider will only receive these attributes when the school has given explicit permission by signing an Attribute Release Policy form.

Attributename Description Format Example
nlEduPersonRealId 1 Onversleutelde versie van het uid [userId]@[realm] pietjepuk@petteflat
givenName 2 First name string Piet
nlEduPersonTussenvoegsels Tussenvoegsel string van
sn 2 Surname string Pukkelen
mail Email adres string pietjepuk@petteflat.nl
initials Initials string P.
homePhone Telefoonnummer (vast) string +31791234567
mobile Mobiel nummer string +31612345678
homePostalAddress Adres Petteflat 121e
2518PP Zoetermeer
nlEduPersonBirthDate Date of birth yyyymmdd 19801231
nlEduPersonProfile Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam string 2345 BOL_ICT.Gamedeveloper
nlEduPersonDepartment Department or sector string Techniek
nlEduPersonUnit Primaire klas/groep. Uniek binnen administratie / schooldomein string H2A
ou Klas of groep string H2A
nlEduPersonCohort Startjaar string 2014
nlEduPersonProfileId ECK attribute
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.
four digit-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.
one digit 1

1 Attention: 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 Attention: 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 dooor te geven. Een overzicht van Attribute Release Policies is te vinden op de support pagina van Kennisnet.