...
- User identifier. Al services reveice 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. True as this isUntil further notice, the SAML2int standard SURFconext adheres to is until further notice 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. |
...
| 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. |
Useful links
If you have an account at an institution you can get information about attributes shared with SURFconext by visiting our profile page. This page gives you insight in which personal data, provided by your institution via SURFconext, has been forwarded to which service and what they look like. 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.
- Profile Page https://profile.surfconext.nl/
- Mail response from Identity Provider to SURFconext or review your attributes: https://engine.surfconext.nl/authentication/sp/debug
Attribute schemas
A schema is an abstract representation of an object's characteristics and relationship to other objects.
SURFconext supports two attribute schemas:
urn:oidschema (SAML2.0 compliant)urnschema (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 supported relaying of the following attributes:
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:oidschema (SAML2.0 compliant)urnschema (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 | |||||
Friendly name | Attribute name | Definition | Data type | Example | |
(NameID) | eduPerson (1) | UTF8 string | bd09168cf0c2e675b2def0ade6f50b7d4bb4aae | ||
urn:mace:dir:attribute-def:sn | X.520 | UTF8 string | Doe Vermeegen | Doe Vermeegen | |
urn:mace:dir:attribute-def:givenName | X.520 | UTF8 string | John Mërgim Lukáš Þrúður | ||
urn:mace:dir:attribute-def:cn | X.520 | UTF8 String | John Doe Prof.dr. Mërgim Lukáš Vermeegen 加来 千代, PhD. | ||
urn:mace:dir:attribute-def:displayName | UTF8 String | Dr. John Doe Prof.dr. Mërgim L. Vermeegen 加来 千代, PhD. | |||
urn:mace:dir:attribute-def:mail | RFC-5322 address | m.l.vermeegen@university.example.org maarten.'t.hart@uniharderwijk.nl "very.unusual.@.but valid.nonetheless"@example.com mlv@[IPv6:2001:db8::1234:4321] | |||
urn: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 | urn:mace:terena.org:schac:homeOrganizationType:int:university urn:mace:terena.org:schac:homeOrganizationType:es:opi | |||
| Employee/student number | urn:schac:attribute-def:schacPersonalUniqueCode | Schac | RFC-2141 URN | urn:schac:urn:schac:personalUniqueCode:nl:local:example.edu:employeeid:x12-3456 urn:schac:personalUniqueCode:nl:local:example.nl:studentid:s1234567 | |
urn:mace:dir:attribute-def:eduPersonAffiliation | Enum type (UTF8 String) | employee, student, faculty, member, affiliate, pre-student(staff is deprecated; library-walk-in, alum are not allowed) | |||
| Scoped affiliation | urn:mace:dir:attribute-def:eduPersonScopedAffiliation urn:oid:1.3.6.1.4.1.5923.1.1.1.9 | eduPerson (1) | UTF8 String user@domain | student@uniharderwijk.nl employee@uniharderwijk.nl | |
urn:mace:dir:attribute-def:eduPersonEntitlement | eduPerson (1) | RFC-2141 URN Multi-valued | to be determined per service (see Standardized values for eduPersonEntitlement) | ||
urn:mace:dir:attribute-def:eduPersonPrincipalName | eduPerson (1) | UTF8 String user@scope | piet.jønsen@example.edu not.a@vålîd.émail.addreß | ||
urn:mace:dir:attribute-def:isMemberOf | eduMember | RFC-2141 URN | urn:collab:urn:collab:org:surf.nl urn:collab:org:clarin.org | ||
urn:mace:dir:attribute-def:uid | UTF8 String | s9603145 flåp@example.edu | |||
urn:mace:dir:attribute-def:preferredLanguage | List of BCP47 language tags | nl nl, en-gb;q=0.8, en;q=0.7 | |||
| ORCID | urn:mace:dir:attribute-def:eduPersonORCID urn:oid:1.3.6.1.4.1.5923.1.1.1.16 eduPerson (1) | URL registered with ORCID.org | http://orcid.org/0000-0002-1825-0097 | ||
| ECK ID | urn:mace:surf.nl:attribute-def:eckid | SURF / Edu-K | URL conform Edu-K specification | https://ketenid.nl/spv1/eacf3765ad342...cf3a11fe9cab2365f95da3e9965501f7c98e (Attribute made shorter for readability) | |
| SURF CRM ID | urn:mace:surf.nl:attribute-def:surf-crm-id | SURF | GUID of the instiution as used in SURF CRM | ad93daef-0911-e511-80d0-005056956c1a |
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
| Warning | ||
|---|---|---|
| ||
There is a minimum amount of attributes to supply when you connect your IdP to SURFconext. For a list of which of these attributes are required for proper operation, please see on this page , or the explanation in the configuration manuals on the page (Dutch) 'Handleidingen en Richtlijnen'. |
| Info | ||
|---|---|---|
| ||
SURFconext considers the attributes nlEduPersonOrgUnit, nlEduPersonStudyBranch and nlStudielinkNummer deprecated. When you register a new IdP or 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
...
See User identifiers.
...
urn:mace
...
urn:mace:dir:attribute-def:sn
...
urn:oid
...
urn:oid:2.5.4.4
...
Multiplicity
...
single-valued
...
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.
...
| MS AuthnMethodsReferences | http://schemas.microsoft.com/claims/authnmethodsreferences | urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransporthttp://schemas.microsoft.com/claims/multipleauthn |
| urn:mace:dir:attribute-def:ou urn:oid:2.5.4.11 | ICT Services | |
| eduid | urn:mace:eduid.nl:1.1 | 658b6b41-7c13-431d-b3b4-663e9077c24c f4c9afe4-b9e1-42bb-92b8-047ac8711e29 |
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 | ||||
|---|---|---|---|---|
|
...
Notes
...
urn:mace | urn:mace:dir:attribute-def:givenNamesn |
urn:oid | urn:oid:2.5.4.424 |
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 |
...
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 | 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). |
...
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 |
|
...
| urn:mace | urn:mace:dir:attribute-def:eduPersonScopedAffiliation |
| urn:oid | urn:oid:1.3.6.1.4.1.14665923.1151.1211.1.159 |
| 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 |
|
...
urn:mace | urn:mace:dir:attribute-def:eduPersonOrcid |
urn:oid | urn:oid:1.3.6.1.4.1.5923.1.1.1.16 |
Multiplicity | 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 | For more information see https://www.surf.nl/en/news/2016/02/global-author-identifier-service-orcid-now-available-through-surfconext-and-edugain.html Although the attribute is in theory multi-valued, in practice it probably makes sense that it has no more than one value. |
...
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. |
...
(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 |
|
| Anchor | ||||
|---|---|---|---|---|
|
urn:mace | urn:mace:dir:attribute-def:ou |
urn:oid | urn:oid:2.5.4.11 |
Multiplicity | multi-valued |
| Data type | UTF-8 string |
Description | Indicates the department, team, or faculty with which the user is associated within the issuing institution. This attribute is multi-valued, so multiple departments, teams or faculties can be listed |
| Examples |
|
Notes |
|
| Anchor | ||||
|---|---|---|---|---|
|
urn:mace | urn:mace: |
urn:oid
: |
1 |
.1 |
Multiplicity | single-valued |
| Data type |
Microsoft GUID
Description
GUID of the organization to which the IdP belongs, as used in the SURF CRM.
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| UTF-8 string | |
Beschrijving | Targeted unique eduID-identifier for a user |
| Voorbeelden | 658b6b41-7c13-431d-b3b4-663e9077c24c |
Opmerkingen |
|