Create User with Password¶

创建用户，设置初始密码，并将用户添加到 OU。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
name	必需	String	用户名。
email	必需	String	用户邮箱。
password	可选	String	用户密码。若指定用户密码，该密码将成为用户的初始密码。若为空，则返回用于重置用户密码的 Token，后续可通过 Reset Password with Token API 重置用户密码。
domain	可选	String	用户所在的域。若指定域，将创建一个域账号。若为空，将创建一个非域账号。
nickName	可选	String	用户的昵称。
company	可选	String	用户所在的公司。
department	可选	String	用户所在的部门。
position	可选	String	用户的职位。

响应参数¶

名称	数据类型	描述
userId	String	用户 ID。
token	String	用于重置密码的 Token。仅当请求参数 `password` 为空时返回。
success	Boolean	用户是否创建成功。`true` 表示成功，`false` 表示失败。

错误码¶

代码	描述
31400	缺少必要参数，或密码不符合规则。
31403	应用未获取“在本 OU 创建或删除用户账号”API 接口权限。
31404	域不存在，或本 OU 未获取此应用。
31408	用户名或邮箱已存在。
31429	一段时间内密码重置次数过多。

示例¶

请求示例¶

url: /app-portal-service/v2.3/user/createAndJoinViaPwd?orgId=your_org_ID

method: POST

{
  "name": "your_user_name",
  "email": "your_user_email",
  "password": "your_user_password"
}

返回示例¶

{
  "code": 0,
  "message": "",
  "data": {
    "userId": "your_user_id",
    "success": true
  }
}