Join Users¶

不登录 Application Portal 的状态下把一批用户添加进组织。

操作权限¶

需要在 Application Portal 给应用授权“在本 OU 创建或删除用户账号”的权限。

请求格式¶

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

请求参数（Body）¶

名称	必需/可选	数据类型	描述
organizationId	必需	String	组织 ID。如何获取 organizationId 信息>>
userIds	必需	List	要加入组织的用户 ID。

响应参数¶

名称	数据类型	描述
data	Boolean	`true` 表示加入成功，`false` 表示加入失败。

错误码¶

代码	描述
31400	参数错误，长度错误，不能为空等
31403	应用未被授权“在本 OU 创建或删除用户账号”的权限
31404	未找到组织

示例¶

请求示例¶

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
}

Java SDK 调用示例¶

public class AppPortalSdkTest{
    @Test
    public void joinUsers() {
            ArrayList<String> userIds = new ArrayList<>();
            userIds.add("user1");
            userIds.add("user2");
            userIds.add("user3");
            UsersJoinRequest usersJoinRequest = new UsersJoinRequest(userIds,"your_org_id");
            Response response = Poseidon.config(PConfig.init().appKey("your_access_key").appSecret("your_secret_key").debug())
                    .url("https://{apigw-address}").getResponse(usersJoinRequest, Response.class);

            System.out.println("List organization res: " + JSON.toJSONString(response));

            assertNotNull("Response should not be null", response);
            assertNotNull("Response data should not be null", response.data);

    }
}