添加成员

更新时间：2026.07.21 10:41

功能说明

向当前租户添加成员。基础账号不存在时会同时创建基础账号，此时 password 必填。

调用说明

地址：

https://www.shudacloud.com/api/open-api/platform/contacts/members/create

方式：POST

接口编码：contacts:members:create

鉴权方式：在请求 Header 中传入 X-API-Key。无需传入 tenant-id，服务端会根据 API Key 自动识别所属租户。

本页参数和返回值来自测试环境真实调试；请求示例中的域名已按生产环境填写。当前示例 API Key 仅在测试环境有效。

请求参数

名称	位置	类型	是否必选	示例值	描述
X-API-Key	Header	String	是	qop_f9f5d23ff4c84e2aa513e37d08780022	开放平台 API Key
username	Body	String	是	openapi_docs_20260721	用户账号
nickname	Body	String	否	开放接口文档测试成员	用户姓名
deptIds	Body	Array	否	["ea415fa680d92b39e8b7317597d9ce55"]	部门编号列表
roleIds	Body	Array	否	["4c04041aa40b712574ee02f0b2d5d25d"]	角色编号列表
email	Body	String	否	openapi_docs_20260721@shudacloud.com	邮箱
avatar	Body	String	否	https://r.shudacloud.com/tenant/449352795579cf33305092ec3e127ae0/open-platform/image/2026/07/21/e1025b2a52b54bfca389fa0ca8b78f3e_ic-chaosongwode2.png	头像地址
password	Body	String	条件必填	OpenApiDocs@2026	基础账号不存在时必填
status	Body	Integer	否	0	状态：0 启用，1 停用

返回数据

名称	类型	示例值	描述
code	Integer	0	业务状态码，0 表示成功
msg	String	空字符串	业务提示信息
data	String	2afa41e19b19919a0e98fbb341948e30	新增成功的租户成员编号

示例

请求示例

curl --request POST \
  --url "https://www.shudacloud.com/api/open-api/platform/contacts/members/create" \
  --header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022" \
  --header "Content-Type: application/json" \
  --data '{
  "username": "openapi_docs_20260721",
  "nickname": "开放接口文档测试成员",
  "password": "OpenApiDocs@2026",
  "deptIds": [
    "ea415fa680d92b39e8b7317597d9ce55"
  ],
  "roleIds": [
    "4c04041aa40b712574ee02f0b2d5d25d"
  ],
  "email": "openapi_docs_20260721@shudacloud.com",
  "status": 0
}'

正常返回示例

{
  "code": 0,
  "msg": "",
  "data": "2afa41e19b19919a0e98fbb341948e30"
}

常见异常

业务状态码	说明
400	请求参数格式或必填参数校验失败
1002030001	未传入 X-API-Key
1002030002	API Key 无效
1002030003	API Key 已停用
1002030004	当前调用 IP 不在 API Key 白名单内
1002030006	当前 API Key 无权调用该接口

开放接口的业务异常通常仍返回 HTTP 200，请以响应体中的 code 判断调用是否成功。

上一条 根据 userId 获取成员信息 下一条 修改成员