Пользователь клиента (/user/client/)

Owned by Dmitri Savolainen
Last updated: Aug 28, 2020 by Asia Khalitova (Unlicensed)
1 min read

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Пользователь клиента (/user/client/)

Описание

Ресурс предназначен для создания, удаления, а также для управления и уточнения параметров пользователя уровня клиента.

Пользователь уровня клиента имеет доступ к настройкам и ресурсам конкретного клиента, а в зависимости от типа доступа  (access type) либо имеет полный доступ (full), либо доступ только для чтения ('read_only') без права на какие-либо изменения в настройках.

Ресурсы /user/client/

Ресурсы создания, удаления, а также для управления и уточнения параметров пользователя уровня клиента:

POST /client/{client_id}/user/client/

Добавить нового пользователя уровня "Клиент"

Параметры URL

Имя

Тип

Описание

client_id

string

Нужно указать обязательно..

Параметры тела запроса

Имя

Тип

Описание

comment

string

Комментарий (заметка)

status

string

Статус пользователя. Может быть: 'active' либо 'blocked'.

name

string

Нужно указать обязательно.

access

string

Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения).

extra_params

string

Поле дополнительных параметров - можно приспособить для любых целей

timezone

string

Пользовательская тайм-зона

login

string

Нужно указать обязательно.

password

string

Нужно указать обязательно.

email

string

Нужно указать обязательно.

Параметры ответа

Имя

Тип

Описание

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

GET /client/{client_id}/user/client/

Запрос списка пользователей клиента

Параметры URL

Имя

Тип

Описание

client_id

string

Нужно указать обязательно..

Параметры запроса (фильтр)

Имя

Тип

login

array [string]

id

array [integer]

Параметры ответа

Имя

Тип

Описание

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

PUT /client/{client_id}/user/client/{user_id}

Обновление пользователя клиента

Параметры URL

Имя

Тип

Описание

user_id

integer

Нужно указать обязательно.

client_id

string

Нужно указать обязательно.

Параметры тела запроса

Имя

Тип

Описание

comment

string

Комментарий (заметка)

status

string

Статус пользователя. Может быть: 'active' либо 'blocked'.

name

string

Видимое имя пользователя

access

string

Тип доступа к ресусрам. Может быть 'full' либо 'read_only' (нет прав на изменения).

extra_params

string

Поле дополнительных параметров - можно приспособить для любых целей

timezone

string

Пользовательская тайм-зона

password

string


email

string


Параметры ответа

Имя

Тип

Описание

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

GET /client/{client_id}/user/client/{user_id}

Запрос параметров пользователя

Параметры URL

Имя

Тип

Описание

user_id

integer

Нужно указать обязательно.

client_id

string

Нужно указать обязательно.

Параметры ответа

Имя

Тип

Описание

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

ID данного ресурса

DELETE /client/{client_id}/user/client/{user_id}

Удаление польователя клиента

Параметры URL

Имя

Тип

Описание

user_id

integer

Нужно указать обязательно.

client_id

string

Нужно указать обязательно.

Теги по теме