Parameter | Description |
---|---|
Change Password At Next Login | Indicates if the user is forced to change their password at next login. This setting doesn’t apply when the user signs in via a third-party identity provider. |
Family Name | The user’s last name. Required when creating a user account. |
First Name | The user’s first name. Required when creating a user account. |
Password | User’s password. |
Primary Email | The user’s primary email address. This property is required in a request to create a user account. The primaryEmail must be unique and cannot be an alias of another user. |
Parameter | Description |
---|---|
Custom Fields | A JSON object of Custom fields of the user. The custom fields are grouped by schema in standard JSON format. Single-valued custom fields are set as simple key-value pairs, like “field1”: “value1”. Multi-valued custom fields are set as arrays of objects, like the standard multi-value fields in the API such as organizations and relations. Example:
|
Delegated User Override | Perform the action on behalf of another user, overriding the delegated user defined in the connection. If not specified, the delegated user is the one provided in the connection. Has no effect when using an OAuth connection. NOTE: the connection details are not edited by this input. |
External IDs | A JSON list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. Example input with detailed fields:
|
Organizations | A JSON list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. Example input:
|
Relations | A JSON list of the relationships of the user to other users. The maximum allowed data size for this field is 2Kb. Example input with detailed fields:
|
Secondary Email | This is the email address where the new user receives their new account details. Also functions as the user’s recovery email. |