Get Users UserGroup List


不登录 EnOS 应用门户的状态下获取一批用户的用户组。

操作权限


需要在 EnOS 应用门户给应用授权“获取本 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 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": "your_user_id",
        "userGroupIds": [
          "your_user_group_id_1",
          "your_user_group_id_2",
          "your_user_group_id_3",
          "your_user_group_id_4",
          "your_user_group_id_5"
        ]
      }
    ],
    "userGroups": [
      {
        "name": "your_user_group_name_1",
        "id": "your_user_group_id_1"
      },
      {
        "name": "your_user_group_name_2",
        "id": "your_user_group_id_2"
      },
      {
        "name": "your_user_group_name_3",
        "id": "your_user_group_id_3"
      },
      {
        "name": "your_user_group_name_4",
        "id": "your_user_group_id_4"
      },
      {
        "name": "your_user_group_name_5",
        "id": "your_user_group_id_5"
      }
    ]
  }
}