...
Parameter | Type | Description |
|---|---|---|
| token (required) | string | Access token. You can obtain a token by making a request |
| email (optional) | string | Email of the new user |
| login (required) | string | Login of the new user |
| password (optional) | string | The password of the new user |
| departmentId (required) | string | Department ID the user will be added to |
| sendLoginEmail (optional, default: false) | bool | A parameter that determines whether an email is sent to the added user |
| invitationMessage (optional, required if the sendLoginEmail parameter is set to true) | string | The text of the email invitation message that is sent to the added user |
| sendLoginSMS (optional, default: false) | bool | The parameter that determines whether an SMS is sent to the added user |
| invitationSMSMessage (optional, required if the sendLoginSMS parameter is set to true) | string | The text of the SMS that is sent to the added user |
| role (optional) | string | If you assign one of the standard roles to the user (except for Account Owner), use one of the following values for the role parameter:
Learn more about using the role parameter in the Important section |
| roleId (required if the custom value is used for the role parameter) | string | The roleId parameter is used, if you assign one of the custom roles to the user. In this case, you will need to use the needed role ID for the roleId parameter Learn more about using the roleId parameter in the Important section. |
manageableDepartmentIds (required if the user's role is Department Administrator, or a custom role) | string[] | An array with the IDs of the departments the user will manage |
| groups (optional) | string[] | An array with the IDs of the groups the user will be added to |
| roles (optional) | string[] | An array of data using which you can assign one or two roles to a user. You will need to use the needed role ID for the roleId parameter inside the array If you assign two roles, one of them will be Learner, and the second role — one of the administrative roles (Account Administrator, Department Administrator, or a custom role). Learn more about using the roles parameter in the Important section |
...