Разрешения

/api/permissions методы.

DELETE /api/permissions/group/:group-id

Удалить специальную группу разрешений PermissionsGroup.

Параметры:

  • group-id

DELETE /api/permissions/membership/:id

Удалить пользователя из группы разрешений PermissionsGroup (удалить его членство в группе).

Параметры:

  • id целое число больше нуля.

GET /api/permissions/execution/graph

Получить граф разрешений на выполнение.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

GET /api/permissions/graph

Получить график всех v1 разрешений (исключая v2 запросы и разрешения на данные).

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

GET /api/permissions/graph-v2

Получить граф всех v2 разрешений (исключая v1 запросы и разрешения на данные).

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

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 логическое значение, может быть пустым.

PUT /api/permissions/execution/graph

Произвести массовое обновление разрешений на выполнение, передав измененный граф. Измененный граф должен быть в том же формате, что и возвращаемый соответствующим GET-запросом.

Ревизии графа разрешений отслеживаются. Если вы получите граф разрешений, а какая-то другая третья сторона изменит его до того, как вы отправите свою версию, то метод не внесет никаких изменений и вернет ошибку 409 (конфликт).

В этом случае вы должны получить обновленный граф и повторно внести в него все изменения.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • body карта.

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 логическое значение.

<< Назад к разделу API