Create User and Choose Organization¶

创建用户并为该用户分配 OU。

前提条件¶

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

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.3/user/createAndJoinOrg

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。需与请求参数 `organizationId` 指定的值一致。如何获取 orgId 信息 >>

请求参数（Body）¶

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

响应参数¶

名称	数据类型	描述
userId	String	新建用户的 ID。

错误码¶

代码	描述
31400	OU ID 为空，用户名为空，邮箱为空，应用无效等。
31403	应用未被授予“在本 OU 创建或删除用户账号”的权限。
31404	OU 或域不存在。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.3/user/createAndJoinOrg?orgId=your_org_id

method: POST

requestBody:
{
  "organizationId": "your_structure_id",
  "nickName": "your_nickname",
  "domain": "your_domain",
  "name": "your_user_name",
  "locale": "en_US",
  "email": "your_email"
}

返回示例¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "userId": "your_user_id"
    }
}