Skip to main content
GET
共享用户是您邀请加入 Scanova 账户的团队成员——与仪表盘 Users 表格中展示的列表相同。此端点让您可以以编程方式列出、邀请、更新或移除他们。
此端点此前未被记录过文档。它需要一个拥有 MANAGEMENT_API(或 MANAGEMENT_API_SANDBOX)配额的 Management API 密钥,以原始 Authorization 请求头的值发送——参见 Management API 概览——外加账户自身用于共享用户的 Team 配额。关于每个角色实际授予的权限,请参见角色与权限;关于角色本身的数据格式,请参见角色(访问级别)
已针对一个尚未邀请任何团队成员的测试账户完成线上核实——因此 results 为空。下方展示的数据结构(来自底层序列化器)是团队成员存在后每个条目的样子。
string
对共享用户的邮箱地址进行精确匹配筛选。
string
对共享用户的名字进行不区分大小写的子字符串匹配。
string
以逗号分隔的角色名称筛选,例如 Admin,Manager
string
invitation_sentactiveinactive 之一。
string
enableddisabledpending 之一。
string
shared_user__emailshared_user__first_name,或在前面加 - 表示降序。

响应字段(每个条目)

integer
共享用户记录 ID——在下方的获取/更新/删除端点中作为 {pk} 使用。
object
被邀请用户的账户。
object
所分配的角色,其数据结构与 GET /multi-users/access-levels/ 返回的相同。
string
计算得出的状态:Invitation SentActiveInactive(60 天以上未登录)或 Locked
boolean
该共享用户的账户是否处于活跃状态(与 status 不同——已停用的用户无论邀请状态如何,始终显示 is_active: false)。
string | null
(最近一次)邀请邮件的 ISO 8601 时间戳。
string | null
邀请被接受的 ISO 8601 时间戳,如果仍待处理则为 null
boolean
如果为 true,此用户的二维码可见范围会被限制为下方 tags 中的标签。
boolean
当启用基于标签的权限时,该用户是否也能看到未打标签的二维码。
array
此用户被限定的标签(仅当 enable_tag_permission 为 true 时才有意义),以 {id, name} 形式呈现。
string
string

相关内容

  • 邀请共享用户 — 同一端点的另一个操作。
  • 获取共享用户 — 对此列表中返回的单个共享用户进行操作。
  • 更新共享用户 — 对此列表中返回的单个共享用户进行操作。
  • 移除共享用户 — 对此列表中返回的单个共享用户进行操作。
  • 列出角色 —— 查找或创建本端点的邀请/更新调用所需的 access_level ID。
  • 创建自定义角色 —— 查找或创建本端点的邀请/更新调用所需的 access_level 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.

响应

200 - application/json

Paginated list of shared users invited to this account.