Полноценное описание пока не готово. В формате справочинка доступно: для уровня "клиент" тут, для уровня "группа добавочных" тут
Ресурс предназначен для
| Table of Contents |
|---|
Описание структур данных
Пример
Ресурсы
Раздел "клиент"
Раздел "группа добавочных"
...
| Warning |
|---|
Мы обновили документацию, актуальная версия страницы доступна по ссылке: Пользователь группы внутренних номеров (/user/extension_group/) |
| Table of Contents | ||
|---|---|---|
|
Описание
Ресурс предназначен для создания, удаления, а также для управления и уточнения параметров пользователя уровня группы добавочных.
Пользователь уровня группы добавочных имеет доступ к настройкам и ресурсам конкретной группы добавочных, а в зависимости от типа доступа (access type) либо имеет полный доступ (full), либо доступ только для чтения ('read_only') без права на какие-либо изменения в настройках.
Ресурсы /user/extension_group/
Ресурсы создания, удаления, а также для управления и уточнения параметров пользователя уровня группы добавочных:
| Table of Contents | ||||
|---|---|---|---|---|
|
POST /client/{client_id}/user/extension_group/
Добавить нового пользователя уровня "Группа добавочных"
Параметры URL
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
Параметры тела запроса
Name | Type | Описание |
|---|---|---|
|
| Комментарий (заметка) |
|
| Статус пользователя. Может быть: 'active' либо 'blocked'. |
|
| Нужно указать обязательно. |
|
| Нужно указать обязательно. ID группы, для которой создается пользователь |
|
| Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения). |
|
| Поле дополнительных параметров - можно приспособить для любых целей |
|
| Пользовательская тайм-зона |
|
| Нужно указать обязательно. |
|
| Нужно указать обязательно. |
|
| Нужно указать обязательно. |
email_notify | boolean | Если True тогда текущему пользователю(кто создает), на почту будут высланы данные для доступа в систему для нового созданного пользователя. |
Параметры ответа
Name | Type | Description |
|---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| ID данного ресурса |
GET /client/{client_id}/user/extension_group/
Получить список пользователей уровня "Группа добавочных"
Параметры URL
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
Параметры запроса (фильтр)
Name | Type | Description |
|---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Параметры ответа
Name | Type | Description |
|---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| ID данного ресурса |
...
PUT /client/{client_id}/user/extension_group/{user_id}
Обновление пользователя уровня "Группа добавочных"
Параметры URL
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
|
| Нужно указать обязательно. |
Параметры тела запроса
Name | Type | Описание |
|---|---|---|
|
| Комментарий (заметка) |
|
| Статус пользователя. Может быть: 'active' либо 'blocked'. |
|
| Видимое имя пользователя |
|
| ID пользователя уровня "Группа добавочных" |
|
| Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения). |
|
| Поле дополнительных параметров - можно приспособить для любых целей |
|
| Пользовательская тайм-зона |
|
| |
|
|
Параметры ответа
Name | Type | Description |
|---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| ID данного ресурса |
GET /client/{client_id}/user/extension_group/{user_id}
Запросить параметры пользователя уровня "Группа добавочных"
Параметры URL
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
|
| Нужно указать обязательно. |
Параметры ответа
Name | Type | Description |
|---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| ID данного ресурса |
DELETE /client/{client_id}/user/extension_group/{user_id}
Удалить пользователя уровня "Группа добавочных"
Параметры URL
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
|
| Нужно указать обязательно. |
Теги по теме
| Related Labels |
|---|