Home > Application Reference > Okta > Update User

Update an Okta user’s system information and profile properties by ID or username.

NOTE: This action will not update information about application users (you will receive a 404 error if the user type is invalid or incorrect). If you need to update an application user, use the ‘Custom API Action’ card, and visit the Okta API Documentation for updating application users.

Unless otherwise indicated, field types are text.

Options

  • Update Semantics (drop-down list)
    • Partial: Updates a user’s profile or credentials with partial update semantics. Any properties that are not specified are ignored, and will maintain their current value.
    • Strict: Updates a user’s profile and/or credentials using strict-update semantics. IMPORTANT: All profile properties must be specified when updating a user’s profile. Any property not specified in the request is set to null.

Input

  • User
    • ID: ID of the Okta user (usually in an email format)

  • Profile

    • City: city or locality component of user’s address
    • Cost center: name of a cost center assigned with the user
    • Country code: country abbreviation
    • Department: name of user’s department
    • Display name: name of the user, suitable for display to end users
    • Division: name of the user’s division
    • Primary email: user’s primary email address
    • Employee number: user’s organization- or company-assigned unique identifier
    • First name: user’s first name
    • Honorific prefix: user’s honorific prefix(es) or title in most Western languages
    • Honorific suffix: user’s honorific suffix(es)
    • Last name: user’s last name or family name
    • Locale: user’s default location for purposes of localizing items like currency, date/time format, and numerical representations
    • Username: login username of the user, usually in the form of an email address
    • Manager: display name of the user’s manager
    • ManagerId: ID of the user’s manager
    • Middle name: user’s middle name
    • Mobile phone: user’s mobile phone number
    • Nickname: user’s preferred nickname, if applicable
    • Organization: name of the user’s organization
    • Postal Address: mailing address component of user’s address
    • Preferred language: user’s preferred written or spoken languages
    • Primary phone: primary phone number of user such as home number
    • Profile Url: URL of user’s online profile (a web page)
    • Secondary email: secondary email address of user (typically used for account recovery)
    • State: state or region component of user’s address
    • Street address: full street address component of user’s address
    • Time zone: user’s time zone
    • Title: user’s title, such as Vice President
    • User type: user’s relationship to the organization, such as Employee or Contractor
    • Zip code: zip code or postal code component of user’s address
    • Custom Profile Properties (dynamically generated): additional custom user profile properties that are generated when configuring this card

  • Credentials

    • Password: string value for the user’s new password
    • Recovery Question: question to enable password recovery for the user
    • Recovery Answer: answer to password recovery question

Output

  • System Properties
    • ID: ID of the Okta user
    • Status: current status of the user: STAGED, PROVISIONED, ACTIVE, RECOVERY, LOCKED_OUT, PASSWORD_EXPIRED, SUSPENDED, or DEPROVISIONED
    • Created (date): timestamp when the user was created
    • Activated (boolean): timestamp when transition to ACTIVE status completed
    • Status Changed (date): date of the user’s last status change
    • Last Login (date): timestamp of the uer’s last login date
    • Last Updated (date): timestamp of the user’s last update
    • Password Changed (boolean): timestamp of the user’s last password change
    • Credentials (list)
      • Emails (list): list of emails associated with the user
      • Password (boolean): true if the user has a valid password or imported hashed password, false otherwise
      • Recovery Question: recovery question when a user forgets their password
      • Provider (object)
        • Name: name of the authentication provider
        • Type: type of authentication provider: OKTA, ACTIVE_DIRECTORY, LDAP, FEDERATION, SOCIAL or IMPORT
  • Profile Properties
    • City: city or locality component of user’s address
    • Cost center: name of a cost center assigned with the user
    • Country code: country abbreviation
    • Department: name of user’s department
    • Display name: name of the user, suitable for display to end users
    • Division: name of the user’s division
    • Primary email: user’s primary email address
    • Employee number: user’s organization- or company-assigned unique identifier
    • First name: user’s first name
    • Honorific prefix: user’s honorific prefix(es) or title in most Western languages
    • Honorific suffix: user’s honorific suffix(es)
    • Last name: user’s last name or family name
    • Locale: user’s default location for purposes of localizing items like currency, date/time format, and numerical representations
    • Username: login username of the user, usually in the form of an email address
    • Manager: display name of the user’s manager
    • ManagerId: ID of the user’s manager
    • Middle name: user’s middle name
    • Mobile phone: user’s mobile phone number
    • Nickname: user’s preferred nickname, if applicable
    • Organization: name of the user’s organization
    • Postal Address: mailing address component of user’s address
    • Preferred language: user’s preferred written or spoken languages
    • Primary phone: primary phone number of user such as home number
    • Profile Url: URL of user’s online profile (a web page)
    • Secondary email: secondary email address of user (typically used for account recovery)
    • State: state or region component of user’s address
    • Street address: full street address component of user’s address
    • Time zone: user’s time zone
    • Title: user’s title, such as Vice President
    • User type: user’s relationship to the organization, such as Employee or Contractor
    • Zip code: zip code or postal code component of user’s address
    • Custom Profile Properties (dynamically generated): additional custom user profile properties that are generated when configuring this card