<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 New Custom Attribute for an Okta User Profile
Okta Classic Engine
Okta Identity Engine
Lifecycle Management
Overview
This article details the steps required to create a custom attribute in Okta. 
Applies To
  • Okta User Profile
  • Universal Directory
  • Lifecycle Management
Solution

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

  1. In the Admin Console, go to Directory > Profile Editor.
  2. Click Okta in the Filters list.
  3. For Okta User (default), click Profile. If Profile is unavailable, click User (default).
  4. Click Add Attribute
Add Attribute
  1. Complete these fields:
    1. Data type: Select one of these data types:
      • string: A chain of zero or more unicode characters (letters, digits, and/or punctuation marks).
      • number: A floating-point decimal in Java's 64-bit Double format. See Platform Specification.
      • boolean: Stores true, false, or null data values.
      • integer: Whole numbers in 64-bit Java's Long format.
      • string array: A sequential collection of strings.
      • number array: A sequential collection of numbers.
      • integer array: A sequential collection of integers.
      • country code: A code representing the country of origin for the user.
      • language code: A code representing the user's language.
      • linked object: A code representing the user's relationship to another attribute.
    2. Display name: A human-readable label that will appear in the UI.
    3. Variable name: Name of the attribute that can be referenced in mappings.
    4. Description: Description of the attribute.
  2. This step is optional. If needed, complete the following fields:

    NOTE: Okta recommends making any attributes used in application user names read-only or hidden.

    • Enum: Select this check box to define an enumerated list of values. 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 check box to indicate the attribute is required.
  3. Click Save or Save and Add Another to add another custom attribute.

 

NOTE:

  • These custom attributes will be arranged in order of creation when viewing them in the Profile Editor.
  •  When creating custom attributes, it is not allowed to use these reserved keywords: "id", "profile", "status", "transitioningtostatus", "created", "createdBy", "activated", "statuschanged", "lastlogin", "lastupdated", "passwordchanged", "type", "realm", "realmId", "password", "credentials", "_links", "_embedded", "class", "classloader".

If choosing to use them, the following error message will appear:

 

Property name is reserved and cannot be used as an attribute name.

 

Error Message

 

Related References

Loading
Create a New Custom Attribute for an Okta User Profile