External DocumentationTo learn more, visit the Okta documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Activate | Executes activation lifecycle operation when creating the user. |
| Primary email address of user. | |
| First Name | Given name of the user. |
| Last Name | Family name of the user. |
| Login Email | Unique email identifier for the user. |
| Mobile Phone | Mobile phone number of the user. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Department | Name of the user’s department. |
| Display Name | Name of the user, suitable for display to end users. |
| Division | Name of the user’s division. |
| Employee Number | Organization or company assigned unique identifier for the user. |
| Manager ID | ID of the user’s manager. |
| Next Login | With activate=true, set nextLogin to changePassword to have the password be EXPIRED, so user must change it the next time they log in. |
| Organization | Name of the user’s organization. |
| Password | The password for the user (or one time password if nextLogin is set to changePassword). |
| Title | User’s title, such as “Vice President.” |
| User Type | Used to describe the organization to user relationship such as “Employee” or “Contractor.” |
Example Output
{
"id": "00ub0oNGTSWTBKOLGLNR",
"status": "STAGED",
"created": "2013-07-02T21:36:25.344Z",
"activated": null,
"statusChanged": null,
"lastLogin": null,
"lastUpdated": "2013-07-02T21:36:25.344Z",
"passwordChanged": null,
"profile": {
"firstName": "Isaac",
"lastName": "Brock",
"email": "isaac.brock@example.com",
"login": "isaac.brock@example.com",
"mobilePhone": "555-415-1337"
},
"credentials": {
"provider": {
"type": "OKTA",
"name": "OKTA"
}
},
"_links": {
"activate": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/activate"
},
"self": {
"href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR"
}
}
}