id, login, or login shortname if the short name is unambiguous.
External DocumentationTo learn more, visit the Okta documentation.
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. |
| Primary email address of user. | |
| Employee Number | Organization or company assigned unique identifier for the user. |
| First Name | Given name of the user. |
| Last Name | Family name of the user. |
| Login Email | Unique identifier for the user (email). |
| Manager ID | ID of the user’s manager. |
| Middle Name | Middle name(s) of the user. |
| Mobile Phone | Mobile phone number of the user. |
| Organization | Name of the user’s organization. |
| Password | New password for the user. |
| Primary Phone | Primary phone number of the user such as home number. |
| Recovery Question | The user’s recovery question. |
| Recovery Question Answer | The user’s recovery question’s answer. |
| Second Email | Secondary email address of user typically used for account recovery. |
| Strict | If true, validates against minimum age and history password policy. |
| Title | User’s title, such as “Vice President”. |
| User ID | ID of the user to update. |
| User Type | Used to describe the organization to user relationship such as “Employee” or “Contractor”. |
Example Output
{
"_embedded": {},
"_links": {},
"activated": "date-time",
"created": "date-time",
"credentials": {
"password": {
"hash": {
"algorithm": "string",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {
"type": "string"
},
"value": "password"
},
"provider": {
"name": "string",
"type": "string"
},
"recovery_question": {
"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "date-time",
"lastUpdated": "date-time",
"passwordChanged": "date-time",
"profile": {
"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "string",
"statusChanged": "date-time",
"transitioningToStatus": "string",
"type": {
"_links": {},
"created": "date-time",
"createdBy": "string",
"default": false,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "date-time",
"lastUpdatedBy": "string",
"name": "string"
}
}