Create and Join User¶

创建用户，指定用户的公司、部门、职位等信息，并为该用户分配 OU。

前提条件¶

应用需拥有“在本 OU 创建或删除用户账号”的权限。如有需要，可联系 OU 管理员获取权限。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/user/createAndJoin

请求参数（Body）¶

名称	必需/可选	数据类型	描述
name	必需	String	用户名。
domain	可选	String	应用门户里注册的域名称。若为创建域账号，需指定一个域名称。若无需创建域账号，需留空。
email	必需	String	用户的邮箱。
organizationId	必需	String	给用户分配的 OU ID。如何获取 organizationId 信息 >>
locale	可选	String	指定以何种语言返回列表信息，支持以下赋值： `en_US`：英语 `zh_CN`：中文 `es_ES`：西班牙语 `ja_JP`：日语 `de_DE`：德语 `pl_PL`：波兰语默认返回中文 `zh_CN` 的列表信息。
nickName	可选	String	用户的昵称。
company	可选	String	用户所在的公司。
department	可选	String	用户所在的部门。
position	可选	String	用户的职位。

响应参数¶

名称	数据类型	描述
data	Boolean	用户是否创建成功。`true` 表示创建成功，`false` 表示创建失败。

错误码¶

代码	描述
31400	参数错误，长度错误，不能为空等。
31403	应用未被授予“在本 OU 创建或删除用户账号”的权限。
31404	未找到 OU、域等。
31408	用户名或邮箱已经存在。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/createAndJoin

method: POST

requestBody:
{
  "name": "yourName",
  "domain": "yourDomain",
  "email": "yourEmail",
  "organizationId": "yourOrgId",
  "locale": "zh_CN",
  "nickName": "yourNickname",
  "company": "yourCompany",
  "department": "yourDepartment",
  "position": "yourPosition"
}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": true
}