The eduPersonAnalyticsTag attribute can be used to enrich resource usage data for reporting and analytics purposes. It is designed to pass user group information (e.g. department, course code, location etc.) to service providers to enable the collection of more detailed usage data and statistics. Not all service providers are able to support the eduPersonAnalyticsTag, so you should discuss it with them before setting it up.

This attribute should not be used to send information that could enable the identification of specific users.

The eduPersonAnalyticsTag is a multi-value attribute, which means that it is possible to pass more than one value at once for a single user. For example, if a student is on a course covered by two different departments, eduPersonAnalyticsTag might have two values: one for each department.

Because eduPersonAnalyticsTag is an attribute, the information can come from the same sources as any other attribute:

  • For OpenAthens managed accounts, it is provided when the user accounts are created or modified.

  • If you have a local connector, you can send the information from your local directory and map it in.

  • You could also assign values using permission sets.

Using an existing attribute

If you have an existing attribute within OpenAthens that you would like to use, you can release it to service providers as eduPersonAnalyticsTag by setting an alias.

  1. Go to Preferences > Attribute release

  2. Click Add a release policy

  3. Search for the resource that you are creating the policy for. Searching by the entityId is the most reliable way to find the specific resource

  4. Select your attribute from the attribute list

  5. Click on the Advanced button

  6. Select your attribute from the drop-down list in the Attribute aliases section

  7. Enter urn:oid:1.3.6.1.4.1.5923.1.1.1.17 as the name to be mapped to

  8. Click Done

  9. Save and repeat for any other resources that you know support it

Using a new attribute

Create a custom attribute

To start with, you will need to define a new attribute in the schema editor. If you are using self-registration, you will need to contact our service desk and ask them to set this up for you.

  1. Log in to your admin account and go to Preferences > Schema editor

    1. If you are going to use permission sets to assign values, you will need to go to the permission set tab

    2. Otherwise, stay on the personal account tab

  2. Click and drag the Text option to the custom attributes section. If you are using OpenAthens accounts, the choice attribute may be a better option as it will let you control which values can be selected.

  3. Enter a target name of urn:oid:1.3.6.1.4.1.5923.1.1.1.17

  4. Set eduPersonAnalyticsTag as the display name

  5. Mark the attribute as releasable and multi-line using the checkboxes

  6. Click Done

  7. Save

Retrieving/setting the information

If you are using local accounts

Next, you need to add a new mapping rule to your local connector. You should make sure that you have configured your local authentication service to release the necessary attribute before starting.

  1. Go to Management > Connections and click on your local connector in the left sidebar

  2. Open up the Attributes tab

  3. Click on Add rule and select Add a mapping rule

    A screenshot of the Attributes tab of a local connector. There are no existing mapping rules. The option to add a new mapping rule is highlighted.
  4. Start typing urn:oid:1.3.6.1.4.1.5923.1.1.1.17 in the target name field and select it from the drop-down

  5. The SAML attribute name needs to be the name of the attribute or claim as it is released from your local authentication service

  6. The display name should be eduPersonAnalyticsTag

  7. Click Done

  8. Save your changes

If you are using OpenAthens managed accounts

Values for eduPersonAnalyticsTag can be provided along with all the usual information when new accounts are created. Existing accounts can be modified individually or in bulk.

If you are using Permission sets

You’ll need to set the value of eduPersonAnalyticsTag for each applicable permission set.

  1. Go to Resources > Permission sets

  2. Click on the permission set that you want to associate a value with

  3. Go to the Attributes tab

  4. Enter the value into the box labelled eduPersonAnalyticsTag

  5. Save changes

Add an attribute release policy

Finally, you need to set up an attribute release policy for each resource that you wish to release your new attribute to.

  1. Go to Preferences > Attribute release

  2. Click Add a release policy

  3. Search for the resource that you are creating the policy for. Searching by the entityId is the most reliable way to find the specific resource

  4. Select eduPersonAnalyticsTag from the attribute list

  5. Click Done

  6. Save