Attribute Mappings
  • 29 Nov 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Attribute Mappings

  • Dark
    Light
  • PDF

Article summary

Attribute Mappings

Some applications support more user attributes than standard things like First Name, Last Name, and email. For these applications, Clarity allows you to configure custom mappings to determine which Clarity attributes should map to which attributes on the downstream application. For instance, the application may have a field for "Gender" and you can set a custom mapping to map one of your configured Identity Attributes to that field in the downstream application.

To view or change an application's attribute mappings, click the "Application Attributes" tab on the application view. (Note: this tab will only diplay for applications that support custom mappings)

image.png


Setting up mappings

For all applications that support writing additional user attributes, Clarity will set up the default mappings out of the box. This will come with all of the required attributes, as well as attributes that are not required and can be modified or deleted as necessary.

image.png

Some of the attributes that are listed may not have an assigned Clarity Attribute. This is because some attributes that we push are derived dynamically and don't come directly from a Standard or Custom attribute. One common example of this is the username attribute, which is not determined from an Identity Attribute, but is instead determined from your configured Username Ruiles.

All of the editable attributes will have a field for "Clarity Attribute Mapping". This is the Identity Attribute that Clarity will use whenever we are pushing user attributes to the downstream application. For example, in the image above, we are pushing the Entra ID attribute "givenName" and we are using Clarity's "First Name" attribute when determining its value for the given user.

In addition to the default attributes that come pre-configured, you can also set up extension attributes (if the downstream application supports it. Consult your application owner if you have questions about this capability).

To add a new custom mapping, fill in the fields at the bottom of the table. You will supply the App Attribute Name and select an existing Identity Attribute from the dropdown. Then click "Add".

image.png

In this case, I will add a new attribute that we will push to the downstream application called "newCustomAttribute" and we will be using the "jobTitle" Clarity Identity Attribute to determine its value.

Note: For some applications, the attribute will need to have a nested structure. For instance, in Entra ID, to set custom extention attributes, the structure needs to be: onPremisesExtensionAttributes -> attribute1, attribute2, attribute3... To accomplish this, you should use "dot notation" for each extenstion attribute you want to push. Clarity will convert the dot notation to the desired structure when pushing the user attributes.

image.png


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.