External DocumentationTo learn more, visit the OneLogin documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Comment | A comment about the user. |
| Company | The company the user belongs to. |
| Department | The user’s department. |
| A valid email for the user. | |
| First Name | The user’s first name. |
| Job Title | The user’s job title. |
| Last Name | The user’s last name. |
| Password | The user’s password. |
| Password Confirmation | Confirm the password. Required if the password is being set. |
| Phone Number | The E.164 format phone number for a user. |
| User ID | The user ID of the user to update. Can be obtained by using the List Users action. |
| Username | A username for the user. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Active Directory Manager ID | The ID of the user’s manager in Active Directory. |
| Active Directory Username | The users Active Directory username. |
| Custom Attributes | An object to contain any other custom attributes you have configured. |
| Directory ID | The ID of the OneLogin Directory the user will be assigned to. |
| Directory Membership | The user’s directory membership. |
| Distinguished Name | The distinguished name of the user. |
| External ID | The ID of the user in an external directory. |
| Group ID | The ID of the Group in OneLogin that the user will be assigned to. |
| Invalid Login Attempts | The number of sequential invalid login attempts the user has made. |
| Mappings | Controls how mappings will be applied to the user on update. async: Mappings will be run after the API returns a response sync: Mappings will be run before the API returns a response disabled: Mappings will not be run for this user. |
| OneLogin Manager ID | The OneLogin User ID of the user’s manager. Can be obtained by using the List Users action. |
| OpenID Name | The name configured for use in other applications that accept OpenID for sign-in. |
| Password Algorithm | Use this when importing a password has already been hashed. For more information refer to OneLogin’s Documentation. |
| Preferred Locale Code | The 2-character language locale for the user, such as en for English or es for Spanish. |
| Role IDs | A list of OneLogin Role IDs the user will be assigned to. |
| Salt | The salt value that was used with the password_algorithm. |
| State | The state of the user. |
| Status | The status of the user. |
| Trusted Idp ID | The ID of the OneLogin Trusted IDP the user will be assigned to. |
| User Principal Name | The principle name of the user. |
| Validate Policy | whether passwords be validated against the User Policy. |