Информация о пользователе

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/user/info

Получение информации о пользователе

PATCH

/rest/v1/user/info

Изменение информации о пользователе

Для всех запросов:
Тип домена: любой

Получение информации о пользователе

Возвращает некоторые основные свойства пользователя, включая роли и группы, а также связанные с ним учетные записи SIP.

Запрос

Пример запроса
GET /rest/v1/user/info HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK

{
  "id": "e7adf0aa-05b7-8163-948c-3392a9660db9",
  "domain": "pbx.era-platform.ru",
  "login": "user",
  "name": "Simple User",
  "email": "my@email.com",
  "avatar": false,
  "groups": [
    {
      "id": "01b0aaeb-0183-d06d-91c9-7cd30a921f58",
      "code": "admins",
      "description": "",
      "opts": {
        "title": "Администраторы домена"
      }
    }
  ],
  "roles": [
    "admin",
    "builder_admin",
    "callcenter_admin",
    "crud",
    "email_admin",
    "monitor",
    "scripteditor",
    "test",
    "user"
  ],
  "sip_accounts": [
    {
      "id": "c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9",
      "login": "7913",
      "phonenumber": "7913"
    },
    {
      "id": "57278625-5fa4-eb0c-fb53-f6fa26881f25",
      "login": "user",
      "phonenumber": "414"
    }
  ]
}
Table 1. Поля ответа
Спецификация Описание

Имя: id
Тип: str

Идентификатор пользователя

Имя: domain
Тип: str

Список групп, в которые входет пользователь непосредственно или каскадным включением.

Имя: login
Тип: str

Логин пользователя.

Имя: name
Тип: str

Имя пользователя.

Имя: email
Тип: str

Email-адрес, назначенный пользователю.

Имя: avatar_info
Тип: any

Метаданные изображения-аватара пользователя. Если аватар не загружен, поле содержит 'false'.
.Пример значения

{
  "name": "simple.jpg",
  "size": 45966,
  "mtime": "2022-12-16T11:20:46Z",
  "hasha": "md5;EB2E803AB7B4112A8FAC044B5CB72EBB"
}

Имя: groups
Тип: array<str>

Список групп, в которые входет пользователь непосредственно или каскадным включением.
Каждая группа представлена идентификатором ('id'), названием ('opts.title'), кодом ('code'), описанием ('description').

Имя: roles
Тип: array<str>

Список ролей, назначенных пользователю непосредственно или через включение в группы.

Имя: sip_accounts
Тип: array<object>

Список назначенных пользователю SIP-аккаунтов (учетных записей sipuser]).
Каждый аккаунт представлен идентификатором ('id'), логином ('login') - он же SIP-username, внутренним телефонным номером (phonenumber).
Идентификатор используется при формировании Endpoint-URL для управления сущностями, связанными с прикрепленными SIP-аккаунтами.

Изменение информации о пользователе

Позволяет модифицировать имя пользователя.

Запрос

Пример запроса
PATCH /rest/v1/user/info HTTP/1.1

{
  "name": "Peter Bukashin"
}

Ответ

Пример ответа
HTTP/1.1 200 OK

{
  "name": "Peter Bukashin"
}