Versions Compared

Key

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

...

HeaderDescription
Authorization (required)Access token. You can obtain a token by making a request
ParameterDescription
user_id (required)The ID of the user whose profile you would like to edit
email (optional)The email of the user. The parameter is passed as part of fields
login (required)The login of the user. The parameter is passed as part of fields
first_name (optional)The first name of the user. The parameter is passed as part of fields
last_name (optional)The last name of the user. The parameter is passed as part of fields
job_title (optional)The job title of the user. The parameter is passed as part of fields
departmentId (optional)The ID of the department the user belongs to
role (optional)

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)

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)

An array with the IDs of the departments the user will manage
groupIds (optional)An array with the IDs of the groups the user will be added to
roles  (optional)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)A user's personal information in the About me field

...