Join Users¶
从其他 OU 批量添加用户至指定 OU。一次最多添加 1000 个用户。
前提条件¶
应用需拥有“获取本 OU 创建或删除用户账号”的权限。如有需要,联系 OU 管理员获取权限。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.2/user/users/join
请求参数(Body)¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| organizationId | 必需 | String | 待添加用户的 OU ID。如何获取 orgId 信息 >> | 
| userIds | 必需 | List | 要加入 OU 的用户 ID,支持输入最多 1000 个用户 ID。如何获取 userId 信息 >> | 
响应参数¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| data | Boolean | 用户是否添加成功。 | 
错误码¶
| 代码 | 描述 | 
|---|---|
| 31400 | 参数错误,长度错误,不能为空等 | 
| 31403 | 应用未被授予“在本 OU 创建或删除用户账号”的权限 | 
| 31404 | 未找到 OU | 
| 31408 | 用户已在所选的 OU 中 | 
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/user/users/join
method: POST
requestBody:
{
  "organizationId":"yourOrgId",
  "userIds": ["user1","user2","user3"]
  }
返回示例¶
{
  "code": 0,
  "message": "OK",
  "data": true
}