Versions Compared

Old Version 2

changes.mady.by.user Alina Levitskaya

Saved on

compared with

New Version Current

changes.mady.by.user Alina Levitskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request
userId (required)stringThe ID of the user whose profile you want to update
email (optional)stringThe email of the user
password (optional)stringThe password of the user
login (required)stringThe login of the user
departmentId (required)stringThe department ID the user belongs to
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:

  • account_administrators
  • department_administrators
  • course_authors
  • learners
  • supervisor

Learn more about using the role parameter in the Important section

roleId (required if the custom value is used for the role parameter)stringThe 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[]Array of 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.
about_me (optional)stringA user's personal information in the About me field


info
Panel
bgColor#eaf4fd

Anchor
Important
Important
Important: 

  1. If in the account there are required user profile fields (apart from the fields of the 'Country' format), they should be also put into the request.

  2. The user role can be assigned in one of two ways:

    1. Using the role (if the assigned role is Account Administrator, Department Administrator, or Learner) and roleId (if the role is a custom role) tags,

    2. Using the roles array of data.

  3. If you use the roles array of data to assign a user role, you will be able to select two roles at once. 

    One of the roles will be Learner and the second role will be one of the administrative roles (Account Administrator, Department Administrator, or a custom role).

    If you add two administrative role to the roles array of data, the user won't be added.

  4. If you have assigned a user role both with the role/roleId tags and the roles array of data, the user will be assigned to a role or roles specified in the roles array of data and the value specified in the role/roleId tags will be then ignored.

  5. If you haven't specified the user role with the role/roleId tags or with the roles array of data, the user will be assigned to the Learner role.


Return Value

After the request has been completed, the system returns an object with the following properties:

...