Add custom attributes to an Okta user profile

Add custom attributes to an Okta user profile to define additional attributes that are not available in the base attributes.

User attribute value fields that are left empty, are processed as "" or an empty string and saved as "" in the profile. User profiles with empty strings are returned when using search=(profile.<propertyName> pr) because they contain a value and not NULL. To set the attribute as NULL, you'll need to use the Okta API. See Okta Developer documentation.

  1. In the Admin Console, go to DirectoryProfile 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.
  5. Complete these fields:
    • 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 language
      • linked object: A code representing the user relationship to another attribute
    • Display name: A human readable label that will appear in the UI
    • Variable name: Name of attribute that can be referenced in mappings
    • Description: Description of the attribute
  6. Optional. Complete the following fields :
    • 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.

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

  7. Click Save or Save and Add Another to add another custom attribute.