Управление пользователями
Длина комментариев (comment
) при API-запросах ограничена 255 символами.
Получение списка пользователей
GET /user_backend/users
Ответ на успешный запрос:
[
{
"id": "integer",
"name": "string",
"login": "string",
"parent_id": "integer",
"enabled": "boolean",
"domain_type": "string", // domain_type ['local'|'ad'|'ald'|'radius']
"domain_name": "string",
"ldap_guid": "string",
"phone_number": "string",
"comment": "string"
}
]
id
- уникальный идентификатор пользователя;name
- имя пользователя;login
- логин пользователя;parent_id
- id-группы;enabled
- соответствует опции Запретить доступ (false - опция Запретить доступ не включена, true - включена);domain_type
- тип домена;domain_name
- имя домена, из которого импортирован пользователь;ldap_guid
- уникальный идентификатор объекта AD;phone_number
- номер телефона пользователя;comment
- комментарий.
Изменение одного пользователя
PUT /user_backend/users/<id>
Json-тело запроса:
{
"name": "string",
"login": "string",
"parent_id": "integer",
"enabled": "boolean",
"domain_type": "string",
"domain_name": "string",
"ldap_guid": "string",
"phone_number": "string",
"comment": "string"
}
name
- имя пользователя;login
- логин пользователя;parent_id
- id-группы;enabled
- оответствует опции Запретить доступ (false - опция Запретить доступ не включена, true - включена);domain_type
- тип домена;domain_name
- имя домена, из которого импортирован пользователь;ldap_guid
- уникальный идентификатор объекта AD;phone_number
- номер телефона пользователя;comment
- комментарий.
Ответ на успешный запрос: 200 OK
Удаление пользователя
DELETE /user_backend/users/<id>
id
- уникальный идентификатор пользователя.
Ответ на успешный запрос: 200 OK
Запрет удаленного подключения для пользователя
PATCH /user_backend/users/<id>/disable-vpn
id
- уникальный идентификатор пользователя.
Тело запроса пустое
Ответ на успешный запрос: 200 OK
Создание пользователя
POST /user_backend/users
Json-тело запроса:
{
"name": "string",
"login": "string",
"psw": "string",
"parent_id": "integer",
"phone_number": ["string"], // не обязательно
"comment": "string"
}
name
- имя пользователя;login
- логин пользователя;psw
- пароль пользователя;parent_id
- id-группы;phone_number
- номер телефона пользователя;comment
- комментарий.
Ответ на успешный запрос:
{
"id": "integer"
}
id
- идентификатор добавленного пользователя.
Если пользователь с указанным логином или именем существует, то исключение с описанием ошибки
Создание группы
POST /user_backend/groups
Json-тело запроса:
{
"name": "string",
"parent_id": "integer"
}
name
- имя группы;parent_id
- id-группы;
Ответ на успешный запрос:
{
"id": "integer"
}
id
- идентификатор добавленной группы.
Если группа с указанным именем у указанного предка существует, то код ответа 542 c описанием ошибки
Получение групп
GET /user_backend/groups
Ответ на успешный запрос:
[
{
"id": "integer",
"name": "string",
"parent_id": "integer",
"domain_type": "string",
"domain_name": "string",
"ldap_guid": "string"
}
]
id
- id группы;name
- имя группы;parent_id
- id родительской группы;domain_type
- тип домена;domain_name
- имя домена, из которого импортирована группа;ldap_guid
- уникальный идентификатор объекта AD.
Изменение группы
PUT /user_backend/groups/<id>
Json-тело запроса:
{
"name": "string",
"parent_id": "integer",
"domain_type": "string",
"domain_name": "string",
"ldap_guid": "string"
}
name
- имя группы;parent_id
- id родительской группы;domain_type
- тип домена;domain_name
- имя домена, из которого импортирована группа;ldap_guid
- уникальный идентификатор объекта AD.
Ответ на успешный запрос: 200 OK
Last updated