Управление пользователями

Длина комментариев (comment) при API-запросах ограничена 255 символами.

Управление пользователями

Получение списка пользователей

GET /user_backend/users

Ответ на успешный запрос:

[
    {
        "id": "integer",
        "name": "string",
        "login": "string",
        "parent_id": "integer",
        "enabled": "boolean",
        "domain_type": "local" | "ad" | "ald" | "radius",
        "domain_name": "string",
        "ldap_guid": "string",
        "phone_number": "string",
        "comment": "string"
    }
]

• id - идентификатор пользователя;

• name - имя пользователя;

• login - логин пользователя;

• parent_id - идентификатор группы;

• enabled - соответствует опции Запретить доступ: true - включена, false - выключена;

• domain_type - тип домена;

• domain_name - имя домена, из которого импортирован пользователь;

• ldap_guid - идентификатор объекта AD;

• phone_number - номер телефона пользователя;

• comment - комментарий.

Создание пользователя

POST /user_backend/users

Json-тело запроса:

{
    "name": "string",
    "login": "string",
    "psw": "string",
    "parent_id": "integer",
    "phone_number": "string" | null,
    "comment": "string"
}

• name - имя пользователя;

• login - логин пользователя;

• psw - пароль пользователя;

• parent_id - идентификатор группы;

• phone_number - номер телефона пользователя, не обязательно;

• comment - комментарий, может быть пустым.

Ответ на успешный запрос:

{
    "id": "integer"
}

• id - идентификатор добавленного пользователя.

Если пользователь с указанным логином или именем существует, то исключение с описанием ошибки.

Изменение одного пользователя

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" | null,
    "comment": "string"
}

• name - имя пользователя;

• login - логин пользователя;

• parent_id - идентификатор группы;

• enabled - соответствует опции Запретить доступ: true - включена, false - выключена;

• domain_type - тип домена;

• domain_name - имя домена, из которого импортирован пользователь;

• ldap_guid - идентификатор объекта AD;

• phone_number - номер телефона пользователя, не обязательно;

• comment - комментарий, может быть пустым.

Ответ на успешный запрос: 200 OK

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

DELETE /user_backend/users/<id пользователя>

Ответ на успешный запрос: 200 OK

Запрет удаленного подключения для пользователя

PATCH /user_backend/users/<id пользователя>/disable-vpn

Ответ на успешный запрос: 200 OK

Создание группы

POST /user_backend/groups

Json-тело запроса:

{
    "name": "string",
    "parent_id": "integer"
}

• name - имя группы;

• parent_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 - идентификатор группы;

• name - имя группы;

• parent_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 - идентификатор родительской группы;

• domain_type - тип домена;

• domain_name - имя домена, из которого импортирована группа;

• ldap_guid - идентификатор объекта AD.

Ответ на успешный запрос: 200 OK

Удаление группы

DELETE /user_backend/groups/<id группы>

Ответ на успешный запрос: 200 ОК

Смена пароля пользователя

PUT /user_backend/change_password/<id пользователя>

Json-тело запроса:

{
    "password": "string"
}

• password - новый пароль пользователя, не может быть пустым.

Ответ на успешный запрос: 200 ОК