<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content

Create a Custom Attribute for an Okta User Profile

Lifecycle Management
Okta Classic Engine
Okta Identity Engine

Overview

Administrators can create custom attributes in the Okta user profile to store additional user data. Configure the data type, display name, and variable name in the Profile Editor to add the custom attribute to the Okta directory.

Applies To

  • Okta Identity Engine (OIE)
  • Okta Classic Engine
  • Okta User Profile
  • Universal Directory
  • Lifecycle Management

Solution

To create a custom attribute, follow the steps or video below.

     

    What are the steps to create a custom attribute for an Okta user profile?

    Create a custom attribute by navigating to the Profile Editor in the Okta Admin Console, selecting the Okta user profile, and configuring the attribute properties.

    1. Navigate to Directory > Profile Editor in the Okta Admin Console.
    2. Select Okta in the Filters list.
    3. Select Profile for the Okta User (default). If Profile is unavailable, select User (default).
    4. Select Add Attribute.
      Add Attribute
    5. Complete the following required fields:
      • Data type: Select the appropriate data type for the attribute. Options include string, number, boolean, integer, string array, number array, integer array, country code, language code, and linked object.
      • Display name: Enter a human-readable label that appears in the UI.
      • Variable name: Enter the name of the attribute referenced in mappings.
      • Description: Enter a description of the attribute.
    6. (Optional) Complete the following optional fields:
      NOTE: Okta recommends making any attributes used in application usernames read-only or hidden.
      • Enum: Select this checkbox to define an enumerated list of values. This supports all data types except boolean.
      • Attribute members: Enter the Display names and Values. For example, small, medium, and large.
      • Restriction: Select Value must be unique for each user to require that the attribute is unique for every user.
      • Attribute length: Enter the minimum and maximum length of the Value field.
      • Attribute required: Select this checkbox to indicate the attribute is required.
    7. Select Save or Save and Add Another to add another custom attribute.

     

    NOTE: Okta arranges these custom attributes in order of creation when viewing them in the Profile Editor.

     

    NOTE: When creating custom attributes, administrators cannot use reserved keywords, including id, profile, status, transitioningtostatus, created, createdBy, activated, statuschanged, lastlogin, lastupdated, passwordchanged, type, realm, realmId, password, credentials, _links, _embedded, class, and classloader. If an administrator uses a reserved keyword, Okta displays a property name reserved error message.

    Error Message

    Related References

    Loading
    Create a Custom Attribute for an Okta User Profile | Okta Support