邀请成员¶

POST /api/v1/workspace/member/batch_invitation

概述¶

邀请一个/多个成员

Body 请求参数¶

参数名	类型	必选	说明
to	array	Y	被邀请者列表例子: ['xxx@guance.com', 'xxx@guance.com'] 允许为空: True
roleUUIDs	array	Y	被邀请者角色 uuid 列表例子: ['wsAdmin'] 允许为空: False
method	string	Y	邀请方式例子: None 允许为空: False 可选值: ['email']

参数补充说明¶

roleUUIDs 说明

角色	说明
wsAdmin	管理员角色，仅 owner / wsAdmin 可邀请
general	标准成员角色
readOnly	只读角色
role_xxx	自定义角色

不支持通过邀请设置 owner 角色。

请求例子¶

curl 'https://openapi.guance.com/api/v1/workspace/member/batch_invitation' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"to": ["xxx@guance.com"], "method": "email", "roleUUIDs": ["general"]}' \
--compressed

响应¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B6A69C1D-ED27-42C2-93FD-BC943F8675D2"
}