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

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
 
(35 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 1: Regel 1:
  +
{{PageTitleCustom|title=Attributes overview for Service Providers|name=Entree Federation|image=true|imageurl=KNF:Hoofdpagina/en}}
{{Talen}}
 
  +
<br/>
 
 
__TOC__
 
__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:
 
  +
* Standard attributes
*Standaard attributen
 
  +
* Additional attributes
*Aanvullende attributen
 
  +
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.
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==
+
==Default attributes==
  +
In this table you can find the attributes that a Service Provider will always receive from Entree Federation.
Hieronder staan de attributen die altijd door Entree Federatie worden doorgegeven aan de Service Provider.
 
 
{| class="wikitable"
 
{| class="wikitable"
! '''Attribuutnaam''' || '''Beschrijving''' || '''Formaat''' || '''Voorbeeld'''
+
! '''Attributename''' || '''Description''' || '''Format''' || '''Example'''
 
|-
 
|-
| 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
+
| 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&nbsp;'''<sup>1</sup>''' || Voornaam || vrij tekstveld || Piet
+
| givenName || First name || string || Piet
 
|-
 
|-
 
| eduPersonAffiliation || Role || student, employee, staff or affiliate || student
| sn&nbsp;'''<sup>1</sup>''' || Achternaam || vrij tekstveld || Pukkelen
 
 
|-
 
|-
 
| nlEduPersonHomeOrganizationId || BRIN code of the institution || 4 or 6 characters || 11ZZ03
| eduPersonAffiliation || Rol || student, employee, staff of affiliate || student
 
 
|-
 
|-
 
| nlEduPersonHomeOrganization || Name of the institution || string || Petteflat College
| nlEduPersonHomeOrganizationId || Brin nummer van de instelling || vrij tekstveld || 01AB
 
|-
 
| nlEduPersonHomeOrganization || Naam van de instelling || vrij tekstveld || Petteflat College
 
 
|}
 
|}
'''<sup>1</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.<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].
+
The Service Provider will only receive these attributes after 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>''' || Unencrypted version of the uid || [userId]@[realm] || pietjepukkelen@petteflatcollege
  +
|-
  +
| 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
  +
|-
  +
| eckId|| Unique ECK pseudonym for students and teachers&nbsp;'''<sup>2</sup>''' || string || <nowiki>https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa</nowiki>
 
|-
 
|-
 
| nlEduPersonTussenvoegsels || Insertion || string || van
| nlEduPersonRealId&nbsp;'''<sup>1</sup>''' || Onversleutelde versie van het uid || [userId]@[realm] || pietjepuk@petteflat
 
 
|-
 
|-
  +
| sn || Surname || string || Pukkelen
| givenName&nbsp;'''<sup>2</sup>''' || Voornaam || vrij tekstveld || Piet
 
 
|-
 
|-
  +
| mail || Email address || string || pietjepukkelen@petteflatcollege.nl
| nlEduPersonTussenvoegsels || Tussenvoegsel || vrij tekstveld || van
 
 
|-
 
|-
  +
| initials || Initials || string || P.
| sn&nbsp;'''<sup>2</sup>''' || Achternaam || vrij tekstveld || Pukkelen
 
 
|-
 
|-
| mail || Email adres || vrij tekstveld || pietjepuk@petteflat.nl
+
| homePhone || Phone number || string || +31791234567
 
|-
 
|-
| initials || Initalen || vrij tekstveld || P.
+
| mobile || Mobile number || string || +31612345678
 
|-
 
|-
 
| nlEduPersonBirthDate || Date of birth|| yyyymmdd || 19801231
| homePhone || Telefoonnummer (vast) || vrij tekstveld || +31791234567
 
 
|-
 
|-
 
| nlEduPersonProfile || Name of study preceded by CREBO<space>.<br/>Optionally BOL_ or BBL_ can be added at the beginning || string || 2345 BOL_ICT.Gamedeveloper
| mobile || Mobiel nummer || vrij tekstveld || +31612345678
 
 
|-
 
|-
 
| nlEduPersonDepartment || Department or sector || string || Techniek
| homePostalAddress || Adres || || Petteflat 121e <br/> 2518PP Zoetermeer
 
 
|-
 
|-
  +
| nlEduPersonUnit || Primary class or group. Unique within the school administration or domain || string || H2A
| nlEduPersonBirthDate || Geboortedatum || yyyymmdd || 19801231
 
 
|-
 
|-
 
| ou || Class or group || string || H2A
| nlEduPersonProfile || Opleidingsnaam voorafgegaan door CREBO<spatie>. OPTIONEEL kan BOL_ of BBL_ toegevoegd worden voor de opleidingsnaam || vrij tekstveld || 2345 BOL_ICT.Gamedeveloper
 
 
|-
 
|-
 
| nlEduPersonCohort || Starting year || string || 2014
| nlEduPersonDepartment || Afdeling of sector || vrij tekstveld || Techniek
 
 
|-
 
|-
  +
| 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: nr. DUO/OND-2013/15135 M.'' || four digit-code || 0011
| nlEduPersonUnit || Primaire klas/groep. Uniek binnen administratie / schooldomein || 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.'' || one digit|| 1
| ou || Klas of groep || vrij tekstveld || H2A
 
 
|-
 
|-
  +
| digiDeliveryId || ECK digital delivery address || string || ED8AE607-WI3N-414C-T87A-624E74S7T005
| nlEduPersonCohort || Startjaar || vrij tekstveld || 2014
 
 
|-
 
|-
  +
| nlEduPersonHomeOrganizationBranchId || Establishment number (BRIN 6) || String of 6 alpha-numeric characters || 11ZZ03
| 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
 
 
|-
 
|-
  +
| preferredLanguage || Preferred Language || Languagecode (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) || 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
 
 
|-
 
|-
  +
| country || Country || Countrycode (https://en.wikipedia.org/wiki/ISO_3166-1) || NL
| 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> Attention:''' The encrypted version of this attribute will always be passed on to Service Providers. To pass on the unencrypted version the school has to sign an Attribute Release Policy.<br/>
  +
'''<sup>2</sup>''' For more information on the ECK-iD: https://www.eck-id.nl/ (in Dutch)
'''<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.
 
   
 
==Attribute release policy==
 
==Attribute release policy==
Een overzicht van attribute release policies is te vinden op [https://support.kennisnet.org/index.php?/Knowledgebase/Article/View/226/0/wat-is-een-arp de support pagina van Kennisnet].
+
A school can give permission to pass on certain additional attributes to a specific Service Provider by signing an Attribute Release Policy. An overview of Attribute Release Policies can be found at [https://support.kennisnet.org/Knowledgebase/Article/View/511/0/er-zijn-meer-attributen-van-gebruikers-nodig-wat-nu the Kennisnet support pages].
   
[[Categorie:Kennisnet Federatie]]
 
 
[[Categorie:Entree Federatie]]
 
[[Categorie:Entree Federatie]]

Huidige versie van 19 dec 2019 om 10:17

KNF-symbol.png Entree Federation: Attributes overview for Service Providers

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.

Default 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 First name string Piet
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

Additional attributes

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

Attributename Description Format Example
nlEduPersonRealId 1 Unencrypted version of the uid [userId]@[realm] pietjepukkelen@petteflatcollege
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 2 string https://ketenid.nl/pilot/8e0a9f57fc76854d3dd2d3c4fa732feaf7b7a2d5f549a5458ce300223b83172f5074aa88a8cef0712aca19b62e9b90d0352e98fc76f498cd3947e7cc810f03fa
nlEduPersonTussenvoegsels Insertion string van
sn Surname string Pukkelen
mail Email address string pietjepukkelen@petteflatcollege.nl
initials Initials string P.
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: nr. DUO/OND-2013/15135 M.
four digit-code 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.
one 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 Languagecode (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) nl
country Country Countrycode (https://en.wikipedia.org/wiki/ISO_3166-1) NL

1 Attention: The encrypted version of this attribute will always be passed on to Service Providers. To pass on the unencrypted version the school has to sign an Attribute Release Policy.
2 For more information on the ECK-iD: https://www.eck-id.nl/ (in Dutch)

Attribute release policy

A school can give permission to pass on certain additional attributes to a specific Service Provider by signing an Attribute Release Policy. An overview of Attribute Release Policies can be found at the Kennisnet support pages.