Configure attributes

This guide walks you through the available configuration options for default and custom attributes.

To configure attributes,

1. On the Asgardeo Console, go to User Attributes & Stores > Attributes.
2. Under Manage Attributes, click Attributes to view the list of all attributes.
3. Click Edit for the attribute you want to update.

General settings

Use the following settings to change details and behavior of an attribute. To configure them, go to the General tab of the attribute.

Note

The Attribute field specifies the unique identifier of the attribute. It always starts with http://wso2.org/claims and not editable.

Attribute Display Name	Update the display name of the attribute that will show in user profiles.
Description	Update the description for the attribute.
Data Type	Refers to the kind of value it holds. Refer to reference for more details.
Allow multiple values for this attribute	Specify whether to support multiple values for this attribute.
Input Format	Specify the kind of input it supports. Refer to reference for more details.
Regular expression	The attribute value will be validated against the regex pattern specified here.
Select Source for Attribute Value of Shared Users	When a user's profile is shared across multiple organizations, the value of this attribute will be taken from the selected source. From Origin: The attribute value is inherited from the original organization which manages the user's profile. From Shared Profile: The attribute value is taken from the shared user profile in the respective organization. From First Found in Hierarchy: The attribute value is retrieved from the first organization in the hierarchy that has assigned a non-null value to the attribute. You can only configure this option for custom attributes.
Uniqueness Validation	Select one of the following scopes to validate attribute uniqueness: None: No validation is applied. Users can have duplicate values for the selected attribute. Within User Store: Users within the same user store can't have duplicate values for the selected attribute. However, users in other user stores may have duplicates. Across User Stores: Attribute values are unique across all user stores preventing duplicates throughout the organization.

Display settings

These settings control where an attribute appears in the Asgardeo Console, and whether the attribute is required or read-only.

To update these settings, open the General tab of your attribute and use the table in the Attribute Configurations section.

The table manages these settings across the following user interfaces:

• Administrator Console: User profiles as seen from the administrator's Console.
• End-User Profile: User profiles as seen from the users' My Account portal.
• Self-Registration: The form presented to users during self-registration.

Display	If selected, the attribute is displayed in the entity.
Required	If selected, the entity must contain a value for this attribute.
Read-only	If selected, the value will be read-only for the entity and can't be modified.

Only for display purposes

These settings only control how the attributes behave in WSO2-managed user interfaces. They do not affect backend or API validation.

Refer these settings from your own end-user UI

If you create a custom end-user profile UI, you can reference these configurations to apply the same rules (Display, Required, Read-only) in your own forms.

Display attributes in the user creation form

You can control whether to display this attribute when onboarding users from the Console. To do so, select both Display and Required for Administrator Console.

Additional settings

Apart from the properties in the General tab, you can configure the following additional settings for an attributes.

Attribute mappings

The Attribute Mappings tab lets you map attributes from each connected user store to the user attribute in Asgardeo. This makes sure the attribute is stored and updated in the correct user store field.

Select storage location for selected attributes

Asgardeo, by default, stores identity attributes internally and user attributes in the connected user stores. If you want to store and manage an identity attribute in your user stores or a user attribute in the identity store, you can do so by following the steps below.

1. On the Asgardeo Console, go to User Attributes & Stores > Attributes.

2. Under Manage Attributes, click Attributes to view the list of all attributes.

3. Click Edit for the attribute you want to update.

4. In the General tab, check/uncheck the Manage in User store checkbox. If,

   • checked: The attribute values for all user stores will be managed in the user store.

   • unchecked: The attribute values for all user stores will be managed internally by the system.

   Note

   This checkbox is, by default,

   • checked for user attributes.
   • unchecked for identity attributes.

   

5. Go to the Attribute Mappings tab and further customize the storage behavior. To do so,

   1. Against each connected user store, check/uncheck the Manage in user store checkbox. If,

      • checked: The attribute values for this user store will be managed in the user store.

      • unchecked: The attribute values for this user store will be managed internally by the system.

   2. Map the attribute from each user store that corresponds to the specific attribute.

   

   Warning

   Changing the attribute storage location may cause any existing attribute values stored in the user store or managed internally to become inaccessible. Ensure that you understand the impact before making this change.

   If you have configured a Read-Only User Store and enable Manage in User Store for an identity attribute, the attribute will not be editable in the user profile. Consequently, certain internal functions that rely on updating these attributes may not work as expected.

6. Click Update to save the changes.