Skip to main content
GET
每个共享用户都会被分配一个角色——Scanova 仪表盘在内部将其称为”访问级别”(access levels),这个术语在本端点中始终沿用。在通过 POST /multi-users/ 邀请团队成员之前,使用此端点查询可用的角色,或从您自己的系统中创建自定义角色。
此端点此前未被记录过文档。它需要一个拥有 MANAGEMENT_API(或 MANAGEMENT_API_SANDBOX)配额的 Management API 密钥——参见 Management API 概览。关于每个角色实际授予团队成员的权限,请参见面向人类读者的角色与权限指南——本页仅记录数据格式。
已通过线上核实:一个全新账户会恰好返回这 6 个系统角色(Viewer、Analyst、Billing Manager、Manager、Admin、Full Access)——与仪表盘 Invite Users 抽屉中的角色与权限选择器相匹配。上方展示的 ID 仅作示例;为求简洁,权限数组在此示例中已被截断——真实响应会包含该角色授予的每一项权限的完整信息。
结果按分页返回(默认每页 10 条),除了 6 个系统默认角色外,还可以包含该账户创建的自定义角色。
string
筛选为 system(内置角色,这些角色的 user 为 null)或 custom(该账户创建的角色)。
对角色名称进行子字符串匹配。
string
name-name

响应字段(每个角色)

integer
角色 ID——在邀请或更新共享用户时作为 access_level 传入。
string
角色显示名称,例如 Manager
string | null
系统角色的稳定 slug(例如 manager);自定义角色为 null
boolean
对于 6 个内置系统角色为 false,对于该账户自行创建的角色为 true
array
此角色授予的每一项权限。

相关内容

  • 创建自定义角色 — 同一端点的另一个操作。
  • 邀请共享用户 —— 在邀请或更新团队成员时,从此列表中分配一个角色 ID。
  • 更新共享用户 —— 在邀请或更新团队成员时,从此列表中分配一个角色 ID。
  • 角色与权限 —— 面向人类读者的说明,介绍每个角色授予的权限,包括自定义角色的套餐门槛。
  • 共享用户 —— 仪表盘的 Users 表格,这些角色在其中通过界面进行分配。

授权

Authorization
string
header
必填

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

查询参数

type
enum<string>
可用选项:
system,
custom
ordering
string

响应

200 - application/json

Paginated list of roles, each with its permission set.