Versions Compared

Key

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

...

ParameterDescription
Authorization (required)Access token. You can obtain a token by making a request
ParameterDescription
user_id (required)The user`s ID

...

ParameterDescription
userProfileAn array with user`s data
userId

The user ID

role

The user's role

Possible values:

  • account_administrators
  • department_administrators
  • course_authors
  • learners
  • supervisor
departmentIdThe ID of the department
status

The user's status

Possible values:

  • 1 —  active
  • 3 —  inactive
  • 5 —  employment ended
fields

An array with data about user profile fields. It includes profile field names and their values

groupsAn array with the group IDs the user is a member of
manageableDepartmentIdsAn array with the IDs of the departments the user manages
userRoles

An array with data about the user's roles

addedDateThe date the user was added to the account
lastLoginDateThe date the user last timed logged in to the account
subordination (optional)An array with data on the type of department supervisor subordination
coSubordination (optional)An array with data on the type of functional manager subordination
subordinationType (required)

The type of supervisor and functional manager subordination

  • inherit — Inherit from parent department
  • manual — Assign manually
  • no_supervisor — No supervisor
workLeaveStatus (optional)

A work leave status. An array with the following parameters:

  • workLeaveReason  
    Reasons for work leave status
  • startDate
    The work leave status start date. You can add it in the yyyy-mm-dd format
  • endDate
    The work leave status end date. You can add it in the yyyy-mm-dd format
supervisorId (optional)The supervisor and functional manager IDSpecify the supervisor ID, if subordinationType = manual
-If subordinationType = inherit, no_supervisor, there is no need to specify the supervisor ID

...