This page will list all the SAML2 attributes that SURFconext and their Identity Providers have to offer. An attribute is a characteristic that describes a user. It is a 'name:value' pair. The attributes included in the SAML assertion correspond to certain attributes a service provider needs to work properly. In general they are needed to:
- Convey user information from the Identity provider or IdP to the service provider
- Create an account for the user at the service provider
- Authorize specific services at the service provider
Now, when a user logs in to a Service Provider, SURFconext sends a SAML assertion to the Service Provider via the browser of the user, that contains a:
- User identifier. Al services receive these and are either a configurable Transient or Persistent NameID.
and Additional attributes. These are optional and differ per Service.
Note |
---|
SURFconext's SAML2 implementation adheres to the SAML2int standard 0.2.1. The header on the link above states that work on saml2int has moved to Kantara Initiative. Until further notice, the SAML2int standard SURFconext adheres to remains at 0.2.1. |
Info |
---|
Before you start digging into the theoretical stuff on this page, you might want to start with our 'best practice' page for an introduction to and how attributes are best used. |
Table of Contents |
---|
User identifiers
The user's identity is transmitted in the form of the NameID element. Every IdP must supply a NameID, but for privacy reasons SURFconext will generate a new one, which is duplicated in the attribute eduPersonTargetedID.
To identify a user the Service Provider must use the NameID or eduPersonTargetedID. The NameID is guaranteed to be stable for a fixed user, except in the case of transient identifiers. SURFconext will generate a NameID for each new user. It is unique for the user and specific to the SP, so SP's cannot correlate their received NameID's between each other. There are two types of NameIDs:
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
A persistent NameID contains a unique string identifying the user for this SP and is persisting over multiple sessions.urn:oasis:names:tc:SAML:2.0:nameid-format:transient
A transient NameID contains a unique string identifying the user for this SP during the session. If the user logs in again, a new transient identifier will be generated.
Warning | ||
---|---|---|
| ||
The NameID and eduPersonTargetedID, which is basically a copy of the NameID, is unlikely to change and very privacy aware but can change when service providers or identity provider make critical changes. This can cause user profiles for services to be lost. The NameID, as used in the SAML assertion to a service provider when loggin' on, is generated using the uid, schacHomeOrganization, the Entity ID of the service provider together with a secret that uses a SHA algorithm. Institutions or services that are in production and change one of these attributes, will cause a new NameID and eduPersonTargetedID to be generated by SURFconext when doing so. This can cause loss of access to profiles at services. We will notify identity providers and service providers when we see a change in one of these attributes to prevent user data being lost. |
Changing attributes
As an Identity Provider it is important to realize that changing attributes in production on SURFconext in any way can have an impact on services users have access to. Attributes that you offer to SURFconext are used to create profiles, and data is often linked to them. Changing an attribute in any way can have unwanted results like users that are no longer able to access their valuable data. An example could be to modify the way you fill the email address (amongst others). For example: changing 'student.123456@university.nl' to 'john.doe@university.nl'. Do you plan to do this or do you start a project where this is the case? Contact us and send an email to support@surfconext.nl.
Useful links
- Table with attributes we recommend our institutions to release: https://wiki.surfnet.nl/display/surfconextdev/Vereiste+attributen
- Profile Page https://profile.surfconext.nl/ , showing what attributes are released by your IdP to SURFconext
- For new IdP's or for IdP's that upgrade their environment: system administrators will at some point be asked to share the metadata of their account for analyses. When asked, visit this page and click the 'Mail to SURFconext' button. We will get back to you when we have judged the submitted metadata.This page will also show you the attributes shared and their values.
Attribute schemas
A schema is an abstract representation of an object's characteristics and relationship to other objects.
SURFconext supports two attribute schemas:
urn:oid
schema (SAML2.0 compliant)urn
schema (SAML1.1 compliant)
Both can be used to convey the same information (except for the NameID, which is only available in the urn:oid
schema). By default SURFconext will provide attributes in both schemas as part of the assertion. However it is not recommended to mix the use of the schemas.
Attribute overview
SURFconext supports relaying of the following attributes:
Friendly name | Attribute name | Example |
---|---|---|
SAML NameID element | bd09168cf0c2e675b2def0ade6f50b7d4bb4aae | |
When a user logs in to a service provider, SURFconext sends a so-called SAML assertion to the service provider. This SAML assertion contains a number of statements about the user who is logging in to you service, including his identity, and possible a number of additional attributes (see below). More information about SAML can be found on this page.
User identifiers
The user's identity is transmitted in the form of the NameId element of the SAML statement. SPs should use the NameId (rather than email address, or other attributes that might change) to identify users, as it is guaranteed to be stable and never change for a fixed user (except in the case of transient identifiers, see below).
SURFconext can provide NameIds of three different types:
- A persistent identifier. A persistent NameId contains a random string that uniquely identifies the user for this SP, and which persists over multiple sessions for the same user..
- A transient identifier. A transient NameId contain a random string that uniquely identifies the user for this SP during the session. Once the user's session at SURFconext expires, a new transient identifier will be generated for the user and SP.
- A legacy identifier. A legacy NameId contains a human-readable dentifier of the form urn:collab:person:example.com:johndoe. This form of the identifier is deprecated and is not available for newly connected services. The reason for this is that SURFconext aims at minimal disclosure of personal information. If the SP needs information that is contained in the legacy NameId format (for example, the user's home institution), they should use proper attributes (for example, schacHomeOrganisation, see below) as a source for this informaiton.
Persistent and transient identifiers are typically of the form "bd09168cf0c2e675b2def0ade6f50b7d4bb4aaef". However, this form may change in the future, and service providers MUST NOT rely on the fact that the NameId is a 40-character hexadecimal string.
Formally, these formats are defined in the SAML2int standard. The two supported NameId types are
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
urn:oasis:names:tc:SAML:2.0:nameid-format:transient
which are specified in sections 8.3.7 and 8.3.8 of the SAML2 core specification.
The legacy format is not standardized, and currently has the type urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified
.
Attributes
By default, SURFconext only transmits persistent NameIds to SPs. However, in many cases these services require more information about the users, such as a name or an email address.
Because of European privacy regulations, we cannot release such information to the SPs by default. In order to receive additional information, the user's home institution needs to give permission for each SP to receive its users' data. Typically, such permission will be arranged for during the initial SURFconext connection procedure.
SURFconext supports 2 'types' of atttributes: urn:oid schema and the urn:mace schema. By default SURFconext will provide attributes in both schemata as part of the assertion. Altough bth are provided, it is not reccommened to mix the use of these schemata.
SURFconext supported relaying of the following attributes:
Friendly name
Attribute name
Definition
Data type
Example
ID
(NameId)
urn:oid:1.3.6.1.4.1.5923.1.1.1.10
Random string
bd09168cf0c2e675b2def0ade6f50b7d4bb4aae
Surname
UTF8 string
(unbounded)
Balkenende
/
Given name
UTF8 string
(unbounded)
Lukáš
??? ??????
Common name
UTF8 String
(unbounded)
Prof.dr. Mërgim Vermeegen
????????? ?????????????
sn |
2. |
5. |
4. |
4 |
UTF8 String
(unbounded)
Prof.dr. Mërgim Vermeegen
????????? ?????????????
Email address
Doe Vermeegen | |
givenName |
2. |
5. |
RFC-5322 address
(max 256 chars)
"very.unusual.@.unusual.com"@example.com
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a13ea0dc-e667-422b-9132-672772cf9c8a"><ac:plain-text-body><![CDATA[user@[
4.42 | John Mërgim Lukáš Þrúður | |
urn:mace:dir:attribute-def:cn | John Doe Prof.dr. Mërgim Lukáš Vermeegen 加来 千代, PhD. | |
urn:mace:dir:attribute-def:displayName | Dr. John Doe Prof.dr. Mërgim L. Vermeegen 加来 千代, PhD. | |
urn:mace:dir:attribute-def:mail | m.l.vermeegen@university.example.org maarten.'t.hart@uniharderwijk.nl "very.unusual.@.but valid.nonetheless"@example.com mlv@[IPv6:2001:db8::1234:4321] |
]]></ac:plain-text-body></ac:structured-macro>
urn: |
Organization
mace:terena.org:attribute-def:schacHomeOrganization |
RFC-1035 domain string
example.nl something |
.example.org |
| |
urn:mace:terena.org:attribute-def:schacHomeOrganizationType |
RFC-2141 URN
see Schac standard
urn:mace:terena.org:schac:homeOrganizationType:int:university urn:mace:terena.org:schac:homeOrganizationType:es:opi |
Employee/student number | urn: |
schac: |
attribute-def: |
schacPersonalUniqueCode |
25178.1. |
2. |
Enum type (UTF8 String)
faculty, student, staff, alum, member, affiliate, employee, library-walk-in
14 | urn:schac:personalUniqueCode:nl:local:example.edu:employeeid:x12-3456 urn:schac:personalUniqueCode:nl:local:example.nl:studentid:s1234567 |
eduPersonAffiliation |
RFC-2141 URN
Multi-valued
to be determined
PrincipalName
1 | employee, student, faculty, member, affiliate, pre-student |
Scoped affiliation |
urn:mace:dir:attribute-def: |
eduPersonScopedAffiliation urn:oid:1.3.6.1.4.1.5923.1.1.1. |
9 |
UTF8 String
user@domain
not.a@vålîd.émail.addreß
??@aninstitutionname
isMemberOf
student@uniharderwijk.nl employee@uniharderwijk.nl | |
eduPersonEntitlement |
1.1. |
RFC-2141 URN
Multi-valued
urn:collab:org:surf.nl
urn:collab:org:clarin.org
7 | to be determined per service (see Standardized values for eduPersonEntitlement) |
uid
eduPersonPrincipalName |
5923. |
1. |
1.1. |
UTF8 String
(max 256 chars)
s9603145
??
preferredLanguage
6 | piet.jønsen@example.edu not.a@vålîd.émail.addreß |
urn:mace:dir:attribute-def: |
isMemberOf |
1. |
3. |
6.1. |
4.1. |
BCP47 language tag
nl-BE
en-US
More information
http://www.incommon.org/federation/attributesummary.html
saml2int.org
Attributes
The following attributes can be included in the response from SURFconext to the service provider. They contain information about the authenticated user. This will make it possible for the service to for instance show the "displayName" of the user in the interface or determine the affiliation of the user for authorization. For instance a student has a different view than a teacher.
Attribute
Attribute (OID)
Example
Remarks
5923.1.5.1.1 | urn:collab:org:surf.nl urn:collab:org:clarin.org | |
urn:mace:dir:attribute-def:uid | s9603145 flåp@example.edu | |
urn:mace:dir:attribute-def:preferredLanguage | nl nl, en-gb;q=0.8, en;q=0.7 | |
ORCID |
urn:oid: |
1. |
3. |
6.1. |
4.1. |
John Doe
Usually this is equal to cn
.
urn:mace:dir:attribute-def:mail
urn:oid:0.9.2342.19200300.100.1.3
john@example.org
5923.1.1.1.16 | http://orcid.org/0000-0002-1825-0097 |
ECK ID | urn:mace: |
surf.nl:attribute-def: |
eckid |
urn:oid:2.5.4.4
Doe
https://ketenid.nl/spv1/eacf3765ad342...cf3a11fe9cab2365f95da3e9965501f7c98e (Attribute made shorter for readability) | |
SURF CRM ID | urn:mace: |
surf.nl:attribute-def: |
surf-crm-id | ad93daef-0911-e511-80d0-005056956c1a | |
MS AuthnMethodsReferences | http://schemas.microsoft.com/claims/authnmethodsreferences | urn: |
oasis:names:tc:SAML:2. |
John Doe
urn:mace:dir:attribute-def:givenName
urn:oid:2.5.4.42
John
urn:mace:dir:attribute-def:eduPersonPrincipalName
urn:oid:1.3.6.1.4.1.5923.1.1.1.6
john_doe@example.org
This is not necessarily a valid email address!
urn:mace:terena.org:attribute-def:schacHomeOrganization
urn:oid:1.3.6.1.4.1.1466.115.121.1.15
example.org
urn:mace:dir:attribute-def:uid
urn:oid:0.9.2342.19200300.100.1.1
john_doe
0:ac:classes:PasswordProtectedTransport http://schemas.microsoft.com/claims/multipleauthn |
Note that not all identity providers might make all attributes available.
(1) eduPerson Object Class Specification (201602): https://wiki.refeds.org/pages/viewpage.action?pageId=44957738
Info | ||
---|---|---|
| ||
SURFconext considers the attributes nlEduPersonOrgUnit, nlEduPersonStudyBranch and nlStudielinkNummer deprecated. When you register a new SP at SURFconext, these attributes will not be allowed for use with SURFconext. Existing IdP's and SP can use these attributes until further notice. |
Detailed attribute descriptions
Anchor | ||||
---|---|---|---|---|
|
See User identifiers.
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:sn |
urn: |
oid | urn:oid: |
2. |
5. |
4. |
student
Supported values: employee
, student
and affiliate
.
urn:mace:dir:attribute-def:isMemberOf
urn:oid:1.3.6.1.4.1.5923.1.5.1.1
urn:collab:org:surf.nl
Contact us before you want to use this attribute!
Note |
---|
In order to uniquely identify a user the persistent Name ID value can be used. This value can be extracted from the Name ID and is also available in the attribute |
Note |
---|
Currently we convert |
Note |
---|
UID is the unique identifier of the user at the home institution, it is not unique for all users in SURFconext! Use eduPersonTargetedID (preferred) or eduPersonPrincipalName if you need to uniquely identify users. |
A service provider SHOULD only at most request the following attributes, requesting these and any other attributes MUST BE accompanied by an explanation of why they are needed:
...
4 | |
Multiplicity | single-valued |
Data type | UTF8 string (unbounded) |
Description | The surname of a person (including any words such as “van”, “de”, “von” etc.) used for Personalization; this can be a combination of existing attributes. |
Examples | Vermeegen 孝慈 |
Notes |
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:givenName |
urn:oid | urn:oid:2.5.4.42 |
Multiplicity | single-valued |
Data type | UTF8 string (unbounded) |
Description | Given name, also known as a first name, forename or Christian name / “name known by”; combinations of title, initials, and “name known by” are possible. |
Examples | Jan Klaassen |
Notes |
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:cn |
urn:oid | urn:oid:2.5.4.3 |
Multiplicity | multi-valued |
Data type | UTF8 string (unbounded) |
Description | Full name. |
Examples | Prof.dr. Mërgim Lukáš Vermeegen 加来 千代, PhD. |
Notes | For example, a typical name of a person in an English-speaking country comprises a personal title (e.g. Mr., Ms., Rd, Professor, Sir, Lord), a first name, middle name(s), last name, generation qualifier (if any, e.g. Jr.) and decorations and awards (if any, e.g. CBE). |
Anchor | ||||
---|---|---|---|---|
|
urn:mace |
...
urn:mace:dir:attribute-def: |
...
displayName |
urn: |
...
oid | urn: |
...
oid:2.16.840.1.113730.3.1.241 | |
Multiplicity | single-valued |
Data type | UTF8 string (unbounded) |
Description | Name as displayed in applications |
Examples | Prof.dr. Mërgim Lukáš Vermeegen 加来 千代, PhD. |
Notes |
|
Anchor | ||||
---|---|---|---|---|
urn:mace | urn:mace:dir:attribute-def:mail |
urn:oid | urn:oid:0.9.2342.19200300.100.1.3 |
Multiplicity | multi-valued |
Data type | RFC-5322 address (max 256 chars) |
Description | e-mail address; syntax in accordance with RFC 5322 |
Examples | m.l.vermeegen@university.example.org "very.unusual.@.unusual.com"@example.com mlv@[IPv6:2001:db8::1234:4321]; the |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:uid |
urn:oid | urn:oid:0.9.2342.19200300.100.1.1 |
Multiplicity | single-valued (multi-valued in the specification, but within SURFconext only 1 value is allowed) |
Data type | UTF8 String (max 256 chars); use of spaces and @ -characters is discouraged. |
Description | The unique code for a person that is used as the login name within the institution. |
Examples | s9603145 |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:terena.org:attribute-def:schacHomeOrganization |
urn:oid | urn:oid:1.3.6.1.4.1.25178.1.2.9 |
Multiplicity | single-valued |
Data type | RFC-1035 domain string. The domain MUST be a secondary-level domain that is under control by the institution. Preferably, the institution's main domain name should be used. |
Description | The user's organization using the organization's domain name; syntax in accordance with RFC 1035. |
Examples | uniharderwijk.nl |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:terena.org:attribute-def:schacHomeOrganizationType |
urn:oid | urn:oid:1.3.6.1.4.1.25178.1.2.10 |
Multiplicity | single-value |
Data type | RFC-2141 URN (see Schac standard) |
Description | designation of the type of organization as defined on http://www.terena.org/registry/terena.org/schac/homeOrganizationType |
Examples | urn:mace:terena.org:schac:homeOrganizationType:int:university urn:mace:terena.org:schac:homeOrganizationType:es:opi |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:schac:attribute-def:schacPersonalUniqueCode |
urn:oid | urn:oid:1.3.6.1.4.1.25178.1.2.14 |
Multiplicity | multi-value |
Data type | RFC-2141 URN (see SURFnet registry) |
Description | The user's student, employee, and/or member id as used in the university's internal systems |
Examples | urn:schac:personalUniqueCode:nl:local:example.edu:employeeid:x12-3456 urn:schac:personalUniqueCode:nl:local:example.nl:studentid:s1234567 |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:eduPersonAffiliation |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.1 |
Multiplicity | multi-valued |
Data type | UTF8 String (only the values enumerated below are allowed) |
Description | Indicates the relationship between the user and his home organization (institution). The following values are permitted within SURFconext:
Use the above mentioned definitions to determine which affiliation a user gets. If the definitions are not sufficient, please use common sense. |
Examples | see above |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:eduPersonScopedAffiliation |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.9 |
Multiplicity | multi-valued |
Data type | UTF8 String of the form affiliation@domain (see below) |
Description | Indicates the relationship between the user and the domain of his home organization. The affiliation part must be one of the allowed values of the eduPersonAffiliation attribute (see definition right above). The value is the role of the user and the domain name of the organisation. eduPersonScopedAffiliation can hence be defined as: <eduPersonAffiliation> "@" <schacHomeOrganization>. Just like eduPersonScopedAffiliation, this is a multi valued attribute. The domain part must be the schacHomeOrganization of the user (or a subdomain thereof). |
Examples | student@uniharderwijk.nl faculty@uniharderwijk.nl |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:eduPersonEntitlement |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.7 |
Multiplicity | multi-value |
Data type | RFC-2141 URN |
Description | entitlement; custom URI (URL or URN) that indicates an entitlement to something. |
Examples |
|
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:eduPersonPrincipalName |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.6 |
Multiplicity | single-valued |
Data type | UTF8 String of the form user@scope |
Description | Unique identifier for a user. |
Examples | piet.jønsen@example.e not.a@vålîd.émail.addreß |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:isMemberOf |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.5.1.1 |
Multiplicity | multi-valued |
Data type | RFC-2141 URN |
Description | Lists the collaborative organizations the user is a member of. |
Examples | urn:collab:org:surf.nl |
Notes |
|
Anchor | ||||
---|---|---|---|---|
|
...
The attributes are available in both human readable format and OID format. See also this eduGAIN recommendation.
Ultimately it is up to the identity provider and service provider to agree on a set of attributes to be released by the IdP, SURFconext only mediates. However, it is strongly recommend to stick to the above attributes as they are standardized and ensure greater interoperability.
The table below lists the attributes that have been defined for use within SURFfederatie. This list was created in consultation with the connected institutions, specifically within the 3TU partnership. With a view to the expected future international collaboration, this table is largely based on the EduPerson and SCHAC tables. A number of attributes that are specific to SURFfederatie and the Netherlands have been added.
Info |
---|
Note that the attributes described on this page are the standardised attributes that an identity provider may provide to the SURFnet federation gateway. If you are a service provider connecting to SURFconext, please refer to the attribute description on ?Authentication using SAML page. |
Attributes overview
A more detailed description of each attribute can be found in the next section.
Attribute Name | Description | Example value(s) |
|
---|---|---|---|
uid | user id/login name | joebloggs | 4236712 |
sn | surname | Bloggs | Smith |
givenName | given name | Joe | Prof. H.A.B. |
cn | full name | Joseph Bloggs |
|
displayName | display name | Joey |
|
e-mail address | j.bloggs@rug.nl | H.A.B.Smith@tudelft.nl | |
eduPersonAffiliation | affiliation type | student | employee |
eduPersonEntitlement | entitlement | ?depends on service provider |
|
eduPersonPrincipalName | unique name | joebloggs@rug.nl |
|
preferredLanguage | preferred language | nl | en |
schacHomeOrganization | domain name | tudelft.nl |
|
schacHomeOrganizationType | type of organisation | urn:mace:terena.org:schac: homeOrganizationType:eu: higherEducationInstitution |
|
nlEduPersonHomeOrganization | name of institution | Delft University of Technology | Utrecht University of Applied Sciences |
nlEduPersonStudyBranch | ROHO code | 52734 |
|
nlEduPersonOrgUnit | department name | Faculty of Humanities | Library |
nlStudielinkNummer | studielink number | xxxxxxxxxx |
|
nlDigitalAuthorIdentifier | DAI number | 070014345 |
|
Detailed attribute descriptions
The names of the attributes in the above table are the commonly used abbreviations. In the description below the attributes are listed using their full name. The SURFfederatie gateway will always provide the attributes by their full name. The attributes are defined in three different namespaces: urn:mace:dir:attribute-def, urn:mace:terena.org:schac and urn:mace:surffederatie.nl:attribute-def.
Attributes defined in urn:mace:dir:attribute-def
International standardised attributes according to the EduPerson schema have been defined within the namespace urn:mace:dir:attribute-def: http://middleware.internet2.edu/urn-mace/urn-mace-dir-attribute-def.html. The version of the EduPerson schema used is: MACE-Dir/Educause, eduPerson Object Class Specification (200806), http://middleware.internet2.edu/eduperson/docs/internet2-mace-dir-eduperson-200806.html, June 2008
urn:mace:dir:attribute-def:uid
Multiplicity | single-value |
Description | The unique code for a person that is used as the login name within the institution. |
Notes |
|
urn:mace:dir:attribute-def:sn
Multiplicity | single-value |
Description | The surname of a person (including any words such as "van", "de", "von" etc.) used for personalisation; this can be a combination of existing attributes. |
Notes |
|
urn:mace:dir:attribute-def:givenName
Multiplicity | single-value |
Description | Given name / "name known by"; combinations of title, initials, and "name known by" are possible. |
Notes |
|
urn:mace:dir:attribute-def:cn
Multiplicity
single-value
Description
Full given name.
Notes
urn:mace |
urn:mace:dir:attribute-def: |
...
preferredLanguage |
Multiplicity | single-value |
Description | Display name as displayed in applications |
Notes |
|
urn:mace:dir:attribute-def:mail
urn:oid | urn:oid:2.16.840.1.113730.3.1.39 |
Multiplicity | single-valued |
Data type | RFC2798 BCP47 |
Description | a two-letter abbreviation for the preferred language according to the ISO 639 language abbreviation code table; no subcodes. |
Examples | nl |
Notes | Used to indicate an individual's preferred written or spoken language. This is useful for international correspondence or human-computer interaction. Values for this attribute type MUST conform to the definition of the Accept-Language header field defined in RFC 2068 with the exception that the value " |
Anchor | ||||
---|---|---|---|---|
|
urn:mace |
Multiplicity
multi-value
Description
e-mail address; syntax in accordance with RFC 1274 and RFC 822.
Notes
urn:mace:dir:attribute |
...
-def:eduPersonTargetedID | |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.10 |
Multiplicity | single-valued |
Data type | UTF8 string (unbounded) |
Description | The attribute eduPersonTargetedID is a copy of the persistent Subject -> NameID, which is generated by SURFconext itself. When an Identity Provider provides the eduPersonTargetedID itself, it is always overwritten by SURFconext. |
Examples | bd09168cf0c2e675b2def0ade6f50b7d4bb4aae |
Notes | This attribute is created because the Subject -> NameID itself is not part of the SAML v2.0 response and therefore only is available for an application if the local SAML implementation explicitly supports this. Within SURFconext the Subject -> NameID is explicitly copied into the |
Anchor | ||||
---|---|---|---|---|
|
urn:mace |
Multiplicity | multi-value |
Description | indicates the relationship between the user and his/her own organisation; possible values:
|
Notes | Note that you must not allow alum or affiliate users to access SURFfederatie. Providing this attribute is not sufficient to deny these users access to SURFfederatie as many service providers do not receive this attribute. Please contact federatie-beheer@surfnet.nl if you have questions about this. |
urn:mace:dir:attribute-def:eduPersonEntitlement
Multiplicity
multi-value
Description
entitlement; URI (URL or URN) that indicates an entitlement to something; is determined by a contract between the service provider and the institution.
Notes
urn:mace:dir:attribute-def: |
...
eduPersonOrcid | |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.16 |
Multiplicity |
single-value
Description
Unique "net ID" beyond the scope of the particular institution, in the form "<user>@<scope>".E.g. "s012001234@student.example.com".
Notes
- Although this value resembles an email address, it should not be used as such. In many cases mail cannot be delivered to this "address".
- This value should never be reassigned to another user. I.e. after a user leaves an institution, it should not be assigned to another (future) user.
urn:mace:dir:attribute-def:preferredLanguage
Multiplicity | single-value |
Description | a two-letter abbreviation for the preferred language according to the ISO 639 language abbreviation code table; no subcodes. |
Notes |
|
Attributes defined in urn:mace:terena.org:attribute-def
International standardised attributes according to the Terena SCHAC schema have been defined within the namespace urn:mace:terena.org:schac: http://www.terena.org/activities/tf-emc2/schacreleases.html. The version of the SCHAC table used is 1.3.0 (12 December 2006).
urn:mace:terena.org:attribute-def:schacHomeOrganization
Multiplicity | single-value |
Description | designation for the person's organisation using the organisation's domain name; syntax in accordance with RFC 1035. |
Notes |
|
urn:mace:terena.org:attribute-def:schacHomeOrganizationType
Multiplicity | single-value |
Description | designation of the type of organisation to which a person belongs, using the values registered by Terena on: http://www.terena.org/registry/terena.org/schac/homeOrganizationType |
Notes |
|
Attributes defined in urn:mace:surffederatie.nl:attribute-def
Nationally standardised attributes within SURFfederatie have been defined within the namespace urn:mace:surffederatie.nl:attribute-def. The name of all these attributes starts with the prefix "nl"
urn:mace:surffederatie.nl:attribute-def:nlEduPersonHomeOrganization
Multiplicity | single-value |
Description |
|
Notes | This attribute is deprecated. It has been replaced by the urn:mace:terena.org:attribute-def:schacHomeOrganization attribute |
urn:mace:surffederatie.nl:attribute-def:nlEduPersonOrgUnit
Multiplicity | multi-value |
Description | Name of the department |
Notes |
|
urn:mace:surffederatie.nl:attribute-def:nlEduPersonStudyBranch
Multiplicity | multi-value |
Description | Study programme; numerical string containing the CROHO code. Empty if the programme is not a regular one. |
Notes |
|
urn:mace:surffederatie.nl:attribute-def:nlStudielinkNummer
Multiplicity | single-value |
Description | A student's Studielink number as registered at www.studielink.nl |
Notes |
|
urn:mace:surffederatie.nl:attribute-def:nlDigitalAuthorIdentifier
multi-valued (see remark below) | |
Data type | URL, registered with ORCID.org |
Description | The ORCID is a persistent digital identifier that distinguishes the account holder from every other researcher. Through integration in research workflows such as manuscript and grant submission, the ORCID identifier supports automated linkages between the account holder and his/her professional activities ensuring that the account holder's work is recognized. Values MUST be valid ORCID identifiers in the ORCID preferred URL representation, i.e. http://orcid.org/0000-0002-1825-0097 |
Examples | |
Notes | Although the attribute is in theory multi-valued, in practice it probably makes sense that it has no more than one value. |
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:surf.nl:attribute-def:eckid |
urn:oid | - |
Multiplicity | single-valued |
Data type | URL as specified by Edu-K, all-lowercase |
Description | Educatieve Content Keten Identifier (ECK ID) is a pseudonymous identifier for access to content for primary, secondary and vocational education. |
Examples |
|
Notes | This attribute may only be used for “the access to and use of digital learning resources or the digital administration of tests and exams”. For more information see https://www.eck-id.nl (Dutch). Also, if you query this claim information from an external data stores, such as an Enterprise Active Directory, Lightweight Directory Access Protocol (LDAP) directories or a Microsoft SQL Server, you can also define custom attribute stores to query the ECK ID claim from external data stores. Read this Microsoft blog to get to know more. |
Anchor | ||||
---|---|---|---|---|
|
urn:mace | urn:mace:surf.nl:attribute-def:surf-crm-id |
urn:oid | urn:oid:1.3.6.1.4.1.1076.20.100.10.50.2 |
Multiplicity | single-valued |
Data type | Microsoft GUID |
Description | GUID of the organization to which the IdP belongs, as used in the SURF CRM. |
Examples | ad93daef-0911-e511-80d0-005056956c1a |
Notes | SURF specific and only to be used by SURF SPs that have to interface with the SURF CRM. Only to be used after consultation with SURFnet. |
Anchor | ||||
---|---|---|---|---|
|
Name | http://schemas.microsoft.com/claims/authnmethodsreferences |
Multiplicity | multi-valued |
Data type | URI |
Description | The AuthnContext-referenties involved in authenticating the current user on their home IdP. |
Examples |
|
Opmerkingen |
|
Multiplicity
single-value
Description
Digital Author Identifier (DAI) as described here
Notes