成员管理接口列表预添加成员

预添加成员

POST/openapi/v1/members/add

将用户预添加至 Space,状态为「待激活」,并发送邀请邮件。用于指定 Space 模式下,在发起 OAuth 授权前准备用户身份。

使用流程: 1. 调用此接口预添加目标用户(状态:待激活),系统自动发送邀请邮件。 2. 发起 OAuth 授权,同时传入 space_idlogin_hint(详见授权端点文档)。 3. 用户在 Consent 页完成登录并点击同意后,成员身份自动激活。

若跳过此步骤: 用户无法通过 OAuth Consent 页进入指定 Space,授权将以 access_denied 被拒绝。

幂等: 若目标邮箱已是该 Space 的待激活或已激活成员,直接返回成功,不重复创建、不重发邀请邮件。

所需 Scopemember:manage


请求参数

Authorization必填string
Bearer <access_token>
X-Operator-User-Id选填string
操作用户 ID。授权码模式下无需传(自动使用授权用户);客户端凭据模式下可选,不填时使用系统用户 ID。
application/json
SpaceId必填string
目标 Space ID,应用须已在该 Space 中安装(active)。
Members必填array<object>
待添加的成员列表。每个成员将以「待激活」状态创建,并收到邀请邮件。
子属性
Email必填string
成员邮箱地址。
Name必填string
成员显示名称,展示在邀请邮件中。
Roles选填array<string>
角色列表。可选值:`admin`(可管理 Space)、`sender`(可创建和发送信封)。不传时默认为 `["sender"]`。

响应参数

SuccessList选填array<object>
成功添加的成员(或已存在——幂等)。
子属性
Email选填string
成员邮箱地址。
Name选填string
成员显示名称。
Status选填string
`success` 或 `failed`。
successfailed
Message选填string
失败原因(仅 Status 为 `failed` 时存在)。
FailList选填array<object>
添加失败的成员,附带失败原因。
子属性
Email选填string
成员邮箱地址。
Name选填string
成员显示名称。
Status选填string
`success` 或 `failed`。
successfailed
Message选填string
失败原因(仅 Status 为 `failed` 时存在)。

错误码

错误码说明
INVALID_REQUEST参数缺失或无效
UNAUTHORIZEDaccess_token 缺失、无效或已过期
FORBIDDEN应用未在目标 Space 安装
INTERNAL_ERROR服务端内部错误