Get Users UserGroup List¶

不登录 Application Portal 的状态下获取一批用户的用户组。

操作权限¶

需要在 Application Portal 给应用授权“获取本 OU 内所有用户的权限信息”的权限。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/userGroup/getUsersUserGroupList

请求参数（Body）¶

名称	必需/可选	数据类型	描述
organizationId	必需	String	组织 ID。如何获取 organizationId 信息>>
userIds	必需	List	用户 ID 列表，支持输入最多 1000 个用户 ID。

响应参数¶

名称	数据类型	描述
data	data 结构体	用户及其对应用户组的信息。

data 结构体¶

名称	数据类型	描述
usersUserGroups	UsersUserGroupListResponse 结构体	用户及其对应用户组的信息。

UsersUserGroupListResponse 结构体¶

名称	数据类型	描述
usersUserGroups	UsersUserGroupsDTO 结构体	用户及其对应用户组的信息。
userGroups	UserGroupInfoDTO 结构体	用户组信息。

UsersUserGroupsDTO 结构体¶

名称	数据类型	描述
userId	String	用户 ID。
userGroupIds	List	用户组 ID 列表。

UserGroupInfoDTO 结构体¶

名称	数据类型	描述
id	String	资产 ID。
name	String	用户组名称。

错误码¶

代码	描述
31400	参数错误，长度错误，不能为空等。
31403	应用未被授权“获取本 OU 内所有用户的权限信息”的权限。
31404	未找到组织，用户不存在于该组织。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/userGroup/getUsersUserGroupList

method: POST

requestBody:
{"organizationId":"yourOrgId","userIds": ["user1","user2","user3"]}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "usersUserGroups": [
      {
        "userId": "u15689477086181",
        "userGroupIds": [
          "ug16112212947831",
          "ug16137850557861477",
          "ug16137850471151721",
          "ug16137850306771912",
          "ug16137849132031966"
        ]
      }
    ],
    "userGroups": [
      {
        "name": "messageProduce",
        "id": "ug16112212947831"
      },
      {
        "name": "Iniciando sesión",
        "id": "ug16137849132031966"
      },
      {
        "name": "Póngase en contacto@",
        "id": "ug16137850306771912"
      },
      {
        "name": "システムエラー。システム管理者に連絡して",
        "id": "ug16137850471151721"
      },
      {
        "name": "中文用户组",
        "id": "ug16137850557861477"
      }
    ]
  }
}

Java SDK 调用示例¶

public class AppPortalSdkTest{
    @Test
    public void getUsersUserGroupList() {
            ArrayList<String> userIds = new ArrayList<>();
            userIds.add("user1");
            userIds.add("user2");
            userIds.add("user3");
            UsersUserGroupListRequest usersUserGroupListRequest = new UsersUserGroupListRequest(userIds,"your_org_id");
            UsersUserGroupListResponse response = Poseidon.config(PConfig.init().appKey("your_access_key").appSecret("your_secret_key").debug())
                    .url("https://{apigw-address}").getResponse(usersUserGroupListRequest, UsersUserGroupListResponse.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);

    }
}