Attributes

The core attributes used in the UK Federation are taken from the eduPerson specifications:

Both the old (200312) and new (200604) forms of eduPersonTargetedID are allowed within the federation and should be supported by service providers.

Attribute Sets

The attributes used within the federation have been categorised into Core Attributes, Subsidiary Attributes and Additional and Custom Attributes, as described in Attribute Sets.

We have a general introduction to the use of attributes for authorisation (with a more detailed discussion of attribute usage in Section 7 of Technical Recommendations for Participants) but the core attributes are:

AttributeMeaning
eduPersonScopedAffiliation:user's organisational affiliation
eduPersonTargetedID:persistent user pseudonym for personalisation
eduPersonPrincipalName:persistent user id across multiple services
eduPersonEntitlement:extensible list of URIs for extra properties

Attribute Usage

The table below shows the attributes recognised by a selection of services. This list is illustrative of attribute usage rather than comprehensive. It is intended to give new participants examples of how attributes are used in practice within the federation. It is not intended to list up-to-date attribute requirements for every service provider. (Identity providers should confirm the requirements directly with the service providers which their end users will access.)

Nevertheless, service providers can assist the community (and reduce their own support load) by asking the federation operator to list their attribute requirements here. To do so, email the federation helpdesk requesting an entry in this table and providing the following information:

  • the name of the service;
  • a brief description of the type of service offered, and who it is intended for;
  • the URL of the log-in page for the service;
  • the attributes used by the service;
  • (where appropriate) the version number of the Shibboleth software used;
  • any specific notes (such as whether additional attributes will give enhanced service).

All information not explicitly displayed in the table will be visible at the service's info page - follow the "more info" link in the rightmost column. This will take you to a service page which also contains the relevant attribute usage notes for accessing that service.

(Blank entries, or entries in {...} brackets in the table below indicate that the information has not yet been provided.)

Please see your IdP's documentation or our Attribute Usage Notes page for information on how to release the correct attributes to each SP.

Note to SP operators

Under certain circumstances you may receive an attribute value consisting of a semi-colon delimited list of values. Should some of these be duplicates, then the best approach is to flatten them down to just the non-unique values. That means that if and when the IdP stops sending the information in multiple ways then the SP will still see it as the same person.

A search for more than one word will find service pages that contain all of the words. Use quotation marks to search for a phrase. Also use quotes for text with punctuation or special characters.

Results of search for fmt=Services.Searcher#tabler4x group=Services name=2???-??-??-* count=999 order=$:Sname link=Documents.AttributeUsage:
OrganisationServiceAttributeRequiredService
Info
Page
LibLynx LLCBritish Online ArchiveseduPersonScopedAffiliation
eduPersonTargetedID
no
no
British Online Archives link
MIMASCensus (Casweb)eduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Census (Casweb) link
MIMASCensus (CIDER)eduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Census (CIDER) link
MIMASCensus (GeoConvert)eduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Census (GeoConvert) link
MIMASCensus (SARs)eduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Census (SARs) link
National Institue of InformaticsCiNiieduPersonTargetedID
mail
o
Yes
No
No
CiNii link
Elsevier ScienceClinical KeyeduPersonTargetedIDNo.Clinical Key link
EDINA, University of EdinburghDigimapeduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Digimap link
ebrary, Inc.ebraryeduPersonScopedAffiliation
eduPersonTargetedID
eduPersonPrincipalName
Yes
See note
See note
ebrary link
Elsevier ScienceEmbaseeduPersonTargetedIDNo.Embase link
Elsevier ScienceEngineering VillageeduPersonTargetedIDNo.Engineering Village link
Equinox PublishingEquinox JournalseduPersonScopedAffiliation
eduPersonTargetedID
yes
yes
Equinox Journals link
MIMASESDS InternationaleduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
ESDS International link
MimasJISC Historic BookseduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
JISC Historic Books link
JISCmailJISCmaileduPersonTargetedIDYesJISCmail link
MIMASJorumeduPersonScopedAffiliation
eduPersonTargetedID
givenName
sn
o
ou
mail
Yes
Yes
No
No
No
No
No
Jorum link
JiscJournal ArchiveseduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Journal Archives link
MA Healthcare LtdMAG Online LibraryeduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
MAG Online Library link
Elsevier ScienceReaxyseduPersonTargetedIDNo.Reaxys link
Elsevier ScienceScienceDirecteduPersonTargetedIDNoScienceDirect link
Elsevier ScienceScopuseduPersonTargetedIDNo.Scopus link
Talis GroupTalis AspireeduPersonScopedAffiliation
eduPersonTargetedID
eduPersonEntitlement
No
Yes
No
Talis Aspire link
Publishing TechnologyThe World Bank eLibraryeduPersonTargetedID
eduPersonPrincipalName
See note
See note
The World Bank eLibrary link
NetskillsTraining MaterialseduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Training Materials link
MyUNiDAYS LtdUNiDAYSeduPersonTargetedID
eduPersonPrincipalName
eduPersonScopedAffiliation
eduPersonAffiliation
eduPersonPrimaryAffiliation
Yes
No
Yes
No
No
UNiDAYS link
Xtreme InformationXtreme InformationeduPersonScopedAffiliation
eduPersonTargetedID
Yes
Yes
Xtreme Information link
26 pages found out of 247 pages searched.