Create Realm User

Create a user in a specific realm, based on selected parameters.

See Create User for more information on creating users in Okta.

Options

Field	Definition	Type	Required
Option	Select an option to use when creating the user profile: Without Credentials With Recovery Question With Password With Password & Recovery question With Authentication Provider In Group As all users within the org are automatically added to the default Everyone group in your Okta org, specifying a Group ID that matches that group returns an error.	Dropdown	TRUE

Field

Definition

Type

Required

Option

Select an option to use when creating the user profile:

Without Credentials
With Recovery Question
With Password
With Password & Recovery question
With Authentication Provider
In Group

As all users within the org are automatically added to the default Everyone group in your Okta org, specifying a Group ID that matches that group returns an error.

Dropdown

TRUE

Input

Input fields vary by option but always include the mandatory Okta profile attributes: Username, First name, Last Name, and Primary email.

A red asterisk denotes any required fields.

Field	Definition	Type	Required
Profile
Username	The username of the Okta user, formatted as an email address.	Text	TRUE
First name	Given name of the user.	Text	TRUE
Last name	Family name of the user.	Text	TRUE
Primary email	The primary email address of the Okta user.	Text	TRUE
Credentials
Question	The password recovery question. This must also include a value in the Answer field.	Text	FALSE
Answer	The answer to the password recovery question. If you enter a value for Question, you must include this field.	Text	FALSE
Password	A password that meets the minimum criteria specified for your org.	Text	FALSE
Provider Name	The name of the authentication provider.	Text	FALSE
Provider Type	The type of authentication provider. These are the possible values: OKTA ACTIVE_DIRECTORY LDAP FEDERATION SOCIAL IMPORT	Text	FALSE
Activate
Activate	Indicates if the user is to be activated after creation.	True/False	TRUE
Realm
ID	Unique identifier of the realm.	Text	TRUE

Output

Field	Definition	Type
Result
User ID	Unique identifier of the user.	Text
Status	Current status of the user. These are the possible values: STAGED PROVISIONED ACTIVE RECOVERY LOCKED_OUT PASSWORD_EXPIRED SUSPENDED DEPROVISIONED	Text
Created	Timestamp when the user was created.	Date & Time
Activated	Timestamp when the transition to ACTIVE status was completed.	Date & Time
Status Changed	Date of the user's last status change.	Date & Time
Last Login	Timestamp when the user last signed in.	Date & Time
Last Updated	Timestamp of the user's last update.	Date & Time
Password Changed	Timestamp of the user's last password change.	Date & Time
Credentials		Object
Password	True if the user has a valid password or an imported hashed password. Otherwise, False.	True/False
Recovery Question	A recovery question that is provided when a user forgets their password.	Text
Provider		Object
Name	The name of the authentication provider.	Text
Type	The type of authentication provider. These are the possible values: ACTIVE_DIRECTORY FEDERATION IMPORT LDAP OKTA SOCIAL	Text
Profile Properties
Username	The sign-in username for the user, usually in the form of an email address.	Text
First name	Given name of the user.	Text
Last name	Family name of the user.	Text
Middle name	The user's middle name.	Text
Honorific prefix	Any honorific prefixes for the user, for example, Dr., Rev., Mr., or Ms.	Text
Honorific suffix	Any honorific suffixes for the user, for example, Jr., Sr., or MBE.	Text
Primary email	The email address of the user.	Text
Title	Job title of the user.	Text
Display name	Name of the user, as displayed to end users.	Text
Nickname	If applicable, the user's preferred nickname.	Text
Profile Url	URL of the user's online profile or web page.	Text
Secondary email	Secondary email address of the user. This is typically used for account recovery.	Text
Mobile phone	The mobile phone number of the user.	Text
Primary phone	The primary phone number of the user, such as their home number.	Text
Street address	Full street address component of the user's address.	Text
City	City or locality of the user's address.	Text
State	State or region component of the user's address.	Text
Zip code	A zip code or postal code component of the user's address.	Text
Country code	Country abbreviation.	Text
Postal Address	Mailing address component of the user's address.	Text
Preferred language	Preferred written or spoken languages of the user.	Text
Locale	The default location of the user. This is used for localizing items like currency, date and time format, and numerical representations.	Text
Time zone	Time zone where the user is located.	Text
User type	User's relationship to the organization, for example, Employee or Contractor.	Text
Employee number	The unique identifier for the user, as assigned to them by the organization or company.	Text
Cost center	The name of a cost center assigned to the user.	Text
Organization	Name of the user's organization.	Text
Division	Name of the user's division.	Text
Department	Name of the user's department.	Text
ManagerId	ID of the user's manager.	Text
Manager	The display name of the user's manager.	Text
Custom Profile Properties	Any additional custom properties generated when configuring this card.	Various
Realm
ID	Unique identifier of the realm.	Text

Create Realm User

Options

Input

Output

Related topics