KNF:Attributen overzicht voor Service Providers: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Regel 12: Regel 12:
 
! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
 
! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
 
|-
 
|-
| uid || 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 || hash@realm || qj7cks8qdz9ph54@petteflat
+
| 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@petteflat
 
|-
 
|-
 
| givenName || Voornaam || vrij tekstveld || Piet
 
| givenName || Voornaam || vrij tekstveld || Piet
Regel 27: Regel 27:
   
 
==Aanvullende attributen==
 
==Aanvullende attributen==
Deze attributen worden alleen aan een bepaalde dienst 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].
+
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].
 
{| class="wikitable"
 
{| class="wikitable"
 
! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
!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&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepuk@petteflat
| '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld''' || '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
 
 
|-
 
|-
  +
| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
| 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;"|&nbsp;'''=><sup>1</sup>'''&nbsp; || nlEduPersonRealId || Onversleutelde versie van het uid || [userId]@[realm] || pietjepuk@petteflat
 
 
|-
 
|-
  +
| sn || Achternaam || vrij tekstveld || Pukkelen
| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
 
 
|-
 
|-
  +
| mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl
| sn || Achternaam || vrij tekstveld || Pukkelen ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=><sup>2</sup>'''&nbsp; || sn || Achternaam || vrij tekstveld || Pukkelen
 
 
|-
 
|-
  +
| initials || Initalen || vrij tekstveld || P.
| mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=><sup>3</sup>'''&nbsp; || mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl
 
 
|-
 
|-
  +
| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
| initials || Initalen || vrij tekstveld || P. ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || initials || Initalen || vrij tekstveld || P.
 
 
|-
 
|-
  +
| mobile || Mobiel nummer || vrij tekstveld || +31612345678
| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567 ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
 
 
|-
 
|-
  +
| homePostalAddress || Adres || || Petteflat 121e <br/> 2518PP Zoetermeer
| mobile || Mobiel nummer || vrij tekstveld || +31612345678 ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || mobile || Mobiel nummer || vrij tekstveld || +31612345678
 
 
|-
 
|-
  +
| nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
| homePostalAddress || Adres || Maximum 6 regels van elk 30 karakters || Petteflat 121e <br/> 2518PP Zoetermeer ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || homePostalAddress || Adres || || Petteflat 121e <br/> 2518PP Zoetermeer
 
 
|-
 
|-
 
| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper
| nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231 ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
 
 
|-
 
|-
  +
| nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek
| 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;"|&nbsp;'''=>'''&nbsp;|| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper
 
 
|-
 
|-
  +
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A
| nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek
 
 
|-
 
|-
  +
| ou || Klas of groep || vrij tekstveld || H2A
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || vrij tekstveld || H2A
 
 
|-
 
|-
  +
| nlEduPersonCohort || Startjaar || vrij tekstveld || 2014
| ou || Klas of groep || vrij tekstveld || H2A ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || ou || Klas of groep || vrij tekstveld || H2A
 
 
|-
 
|-
 
| 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
| nlEduPersonCohort || Startjaar || vrij tekstveld || 2014 ||style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || 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
| 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 || style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || 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 || style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || 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 || style="color: white; background-color: grey; text-align:center;"|&nbsp;'''=>'''&nbsp; || 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
 
 
|}
 
|}
 
'''<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> 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>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>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.
'''<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==

Versie van 14 okt 2016 11:10

Nl.gif Nederlands En.gif 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 wil inloggen.
De set van attributen bestaat uit twee typen attributen:

  • Standaard attributen
  • Aanvullende attributen

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 dienstleverancier 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@petteflat
givenName Voornaam vrij tekstveld Piet
sn 1 Achternaam vrij tekstveld Pukkelen
eduPersonAffiliation Rol student, employee, staff of affiliate student
nlEduPersonHomeOrganizationId Brin nummer van de instelling vrij tekstveld 01AB
nlEduPersonHomeOrganization Naam van de instelling vrij tekstveld Petteflat College

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

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] pietjepuk@petteflat
nlEduPersonTussenvoegsels Tussenvoegsel vrij tekstveld van
sn Achternaam vrij tekstveld Pukkelen
mail Email adres vrij tekstveld pietjepuk@petteflat.nl
initials Initalen vrij tekstveld P.
homePhone Telefoonnummer (vast) vrij tekstveld +31791234567
mobile Mobiel nummer vrij tekstveld +31612345678
homePostalAddress Adres 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 standaard doorgegeven (zie verplichte attributen), voor de onversleutelde versie moet de school een Attribute Release Policy ondertekenen.
2 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.

Attribute release policy

Een overzicht van attribute release policies is te vinden op de support pagina van Kennisnet.