权限

/api/permissions端点。

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

删除特定的PermissionsGroup。

参数

• group-id 的值必须是一个大于零的整数。

DELETE /api/permissions/membership/:id

从权限组中删除用户（删除他们的成员资格）。

参数

• 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 可为空的布尔值。

PUT /api/permissions/graph

通过传递修改后的图来批量更新权限。这应该返回与从 GET /api/permissions/graph 获取的相同的图，以相同的格式，并在必要时进行任何更改。此修改后的图必须与 PermissionsGraph 架构相匹配。如果成功，此端点将返回更新的权限图；将其用作任何进一步修改的基。

权限图的修订版是可追踪的。如果您获取权限图，并且某些第三方在您提交修订版之前修改了它，则端点将不会进行任何更改，并返回 409（冲突）响应。在这种情况下，您应该获取更新的图，并对其进行所需更改。

可选的 sandboxes 键包含应与权限图更新一起创建或修改的沙盒列表。由于数据沙盒是仅适用于企业版的特性，如果存在此键并且服务器未运行企业版，以及/或者未存在 :sandboxes 功能标志，则将返回 402（支付所需）响应。

如果 skip-graph 查询参数为真值，则不会返回图。

执行此操作必须为超级用户。

参数

• skip-graph 可为空的布尔值。

• body 映射。

PUT /api/permissions/group/:group-id

更新 PermissionsGroup 的名称。

参数

• group-id 的值必须是一个大于零的整数。

• name 的值必须是一个非空字符串。

PUT /api/permissions/membership/:group-id/clear

从 PermissionsGroup 中删除所有成员。如果组 ID 是管理员组的 ID，则返回 400（无效请求）。

参数

• group-id 的值必须是一个大于零的整数。

PUT /api/permissions/membership/:id

更新权限组成员资格。返回更新记录。

参数

• id 的值必须是一个大于零的整数。

• is_group_manager 布尔值。

返回到 API 索引