title: "Разрешения" summary: | /api/permissions методы. redirect_from: - /ru/docs/latest/api/permissions
Разрешения¶
/api/permissions методы.
DELETE /api/permissions/group/:group-id¶
Удалить специальную группу разрешений PermissionsGroup.
Параметры:¶
group-idцелое число больше нуля.
DELETE /api/permissions/membership/:id¶
Удалить пользователя из группы разрешений PermissionsGroup (удалить его членство в группе).
Параметры:¶
idцелое число больше нуля.
GET /api/permissions/graph¶
Получить график всех разрешений.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
GET /api/permissions/graph/db/:db-id¶
Получить граф всех разрешений для db-id db-id.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
db-idцелое число больше нуля.
GET /api/permissions/graph/group/:group-id¶
Получить граф всех разрешений для group-id group-id.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
group-idцелое число больше нуля.
GET /api/permissions/group¶
Получить все PermissionsGroups, включая подсчёт количества :members в этой группе. Данный API требует разрешений суперпользователя или менеджера больше чем одной группы. Менеджер группы доступен только, если advanced-permissions включено и возвращает только группы которыми управляет менеджер.
GET /api/permissions/group/:id¶
Получить детали конкретной группы разрешений.
Параметры:¶
idцелое число больше нуля.
GET /api/permissions/membership¶
Получить карту, описывающую членство разных пользователей в группе. Формат карты такой:
{<user-id> [{:membership_id <id>
:group_id <id>
:is_group_manager boolean}]}.
POST /api/permissions/group¶
Создать новую группу разрешений PermissionsGroup.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
nameнепустая строка.
POST /api/permissions/membership¶
Добавить пользователя User в группу PermissionsGroup. Возвращает обновлённый список участников, принадлежащих группе.
Параметры:¶
-
group_idцелое число больше нуля. -
user_idцелое число больше нуля. -
is_group_managerлогическое значение или null.
PUT /api/permissions/graph¶
Выполнить массовое обновление разрешений, передав измененный граф. Возвращает тот же граф в том же формате, который вы получили из GET /api/permissions/graph, с изменениями, внесенными там, где это необходимо. Этот модифицированный граф должен соответствовать схеме PermissionsGraph. В случае успеха этот метод возвращает обновлённый граф разрешений; используйте это как основу для любых дальнейших модификаций.
Изменения граф разрешений отслеживаются. Если вы получите граф разрешений, а какая-то другая третья сторона изменит его до того, как вы отправите свою версию, то метод не внесет никаких изменений и вернёт ошибку 409 (конфликт). В этом случае вы должны получить обновлённый граф и повторно внести в него необходимые изменения. Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Опциональный ключ sandboxes содержит список "песочниц", которые должны быть созданы или изменены вместе с этим обновлением графа разрешений.
Поскольку "песочницы данных" являются функцией только для Enterprise Edition, будет возвращен ответ 402 (требуется оплата), если этот ключ присутствует, а сервер не запущен в Enterprise Edition и / или флаг функции :sandboxes не присутствует.
Параметры:¶
bodyкарта.
PUT /api/permissions/group/:group-id¶
Обновить название группы PermissionsGroup.
Параметры:¶
-
group-idцелое число больше нуля. -
nameнепустая строка.
PUT /api/permissions/membership/:id¶
Обновить членство в группе разрешений. Возвращает обновленную запись.
Параметры:¶
-
idцелое число больше нуля. -
is_group_managerлогическое значение.