通过 OpenAPI 创建用户。
适用版本 | 企业专属版 |
服务接入点与授权信息
获取服务接入点,替换 API 请求语法中的 <domain> :服务接入点(domain)。
获取个人访问令牌,具体操作,请参见获取个人访问令牌。
请求语法
POST https://<domain>/oapi/v1/platform/users
请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
string | body | 否 | 邮箱。 | ||
name | string | body | 是 | 显示用户名。 | |
nickName | string | body | 否 | 昵称。 | |
operatorId | string | body | 否 | 使用非个人访问令牌如应用访问令牌调用时,需指定操作人。 | |
password | string | body | 是 | 密码。 | |
staffId | string | body | 否 | 员工 ID。 | |
sysDeptIds | string | body | 否 | 所属部门,为空时加入站点根部门。 | |
username | string | body | 是 | 登录账号名。 |
请求示例
curl -X 'POST' \
'https://test.rdc.aliyuncs.com/oapi/v1/platform/users' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
-d '{
"email": "string",
"name": "string",
"nickName": "string",
"operatorId": "string",
"password": "string",
"staffId": "string",
"sysDeptIds": [
"string"
],
"username": "string"
}'
返回参数
参数 | 类型 | 描述 | 示例值 |
string | 邮箱。 | ||
id | string | 用户 ID。 | 8446****ce9f |
lastOrganization | string | 最后加入的组织。 | |
name | string | 显示用户名。 | name1 |
nickName | string | 昵称。 | lingma |
staffId | string | 员工 ID。 | |
sysDeptIds | string | 所属部门,为空时加入站点根部门。 | |
username | string | 登录账号名。 |
返回示例
{
"email": "string",
"id": "8446****ce9f",
"lastOrganization": "string",
"name": "name1",
"nickName": "lingma",
"staffId": "string",
"sysDeptIds": [
"string"
],
"username": "string"
}
错误码
访问错误码中心查看 API 相关错误码。
文档内容是否对您有帮助?