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