Skip to main content
POST
共享用户是您邀请加入 Scanova 账户的团队成员——与仪表盘 Users 表格中展示的列表相同。此端点让您可以以编程方式列出、邀请、更新或移除他们。
此端点此前未被记录过文档。它需要一个拥有 MANAGEMENT_API(或 MANAGEMENT_API_SANDBOX)配额的 Management API 密钥,以原始 Authorization 请求头的值发送——参见 Management API 概览——外加账户自身用于共享用户的 Team 配额。关于每个角色实际授予的权限,请参见角色与权限;关于角色本身的数据格式,请参见角色(访问级别)
string
必填
新团队成员的邮箱地址。不得已属于其他 Scanova 用户——重复的邮箱地址会返回一个 400 错误,内容为 {"email": ["Email address is already used."]}
string
必填
显示名称,最多 20 个字符。
integer
必填
来自 GET /multi-users/access-levels/ 的角色 ID——可以是默认的系统角色,也可以是此账户创建的自定义角色。
array
用于限定此用户访问范围的标签 ID。需要账户的 CUSTOM_TAG/标签权限配额——否则会被 403 拒绝。
boolean
默认值:"false"
将此用户可见的二维码限制为 tags
boolean
默认值:"true"
enable_tag_permission 为 true 时,未打标签的二维码是否仍然可见。
邀请团队成员总是会向其发送一封邀请邮件——在此创建记录,与在仪表盘的 Users 表格中点击 Invite Users 效果相同。没有办法通过此端点跳过发送邮件。

相关内容

  • 列出共享用户 — 同一端点的另一个操作。
  • 获取共享用户 — 在邀请该共享用户后,对其记录进行操作。
  • 更新共享用户 — 在邀请该共享用户后,对其记录进行操作。
  • 移除共享用户 — 在邀请该共享用户后,对其记录进行操作。
  • 列出角色 —— 查找或创建本端点的邀请/更新调用所需的 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.

请求体

application/json
email
string<email>
必填
name
string
必填
Maximum string length: 20
access_level
integer
必填

Role ID from GET /multi-users/access-levels/.

tags
integer[]
enable_tag_permission
boolean
默认值:false
include_untagged
boolean
默认值:true

响应

201 - application/json

Invitation created — sends an invitation email to the shared user.