Описание параметров
Имя | Описание | Пример | ||
|---|---|---|---|---|
UserDesc | параметры пользователя | |||
| "uuid": string, | идентификатор пользователя | "uuid": "8370a3b6-7dba603d-2fe71fa6-83e559db", | ||
| "login": string, | логин пользователя | "login": "user", | ||
| "name": string, | ФИО пользователя, указано на вкладке "Данные пользователя" | "name": "name", | ||
| "description": string, | отдел, указан на вкладке "Данные пользователя" | "description": "desc", | ||
| "function": string, | должность, указана на вкладке "Данные пользователя" | "function": "manager", | ||
| "email": string, | электронная почта, указана на вкладке "Данные пользователя" | "email": "user@mail.ru", | ||
| "roles": UserRoles, | роль пользователя "administrator" : 1, администратор | "roles": 10, (роли создания мультисфер и экспорта данных) | ||
| "policy": SessionOpenPolicy, | настройки входа в систему | "policy": 1 | ||
| "layer_id": string, | идентификатор профиля, если "policy":3 | "layer_id":"fa0431d1" | ||
| "script_id": string | идентификатор сценария, если "policy":4 | "script_id":"db0037e1" | ||
| "is_guest": bool | признак гостевого пользователя | "is_guest": false | ||
| "member_of": [GroupDescShort] | список описаний групп, членом которых является пользователь | "member_of": [] | ||
Имя | Описание | Пример | ||
|---|---|---|---|---|
GroupDescShort | параметры групп | |||
| "id": UsersGroupId, | идентификатор группы | "id": "8370a3b6-7dba603d-2fe71fa6-83e559db", | ||
| "name": string | имя группы | "name": "name" | ||
Команды
- Получение данных о текущем пользователе (get_info/info)
- Получение данных о пользователе по логину (get_by_login/info)
- Получение списка пользователей (list_request/list_response)
- Добавление нового пользователя (add_user/add_user_response)
- Удаление пользователя (del_user/response)
- Изменение пароля у текущего пользователя (change_passwd/response)
- Изменение пароля у указанного пользователя (change_user_passwd/response)
- Выход из системы (logout/response)
- Изменение данных пользователя (info/response)
Общие ошибки
Код ошибки | Текст ошибки | Описание |
|---|---|---|
| "code": RequestAuthError (270) | "message": "Only authentication command allowed" | ошибка появляется, когда пользователь не залогинился |
| "code": RuntimeError (200) | "message": "No such user" | ошибка появляется, когда указан несуществующий пользователь |
| "code": RequestError (260) | "message": "User command cast fail." | ошибка появляется, когда не удалось преобразовать команду к UserCommand |
| "code": RequestError (260) | "message": "User command handle fail." | ошибка появляется, когда отправленная команда не описана на сервере |