调用ListUserGroups批量查询用户组-办公安全平台-阿里云

批量查询当前阿里云账号下所有用户组的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
CurrentPage	integer	是	分页查询时显示的当前页的页码。取值：1~10000。	1
PageSize	integer	是	分页查询时设置的每页数量。取值：1~1000。	10
UserGroupIds	array	否	用户组 ID 集合。最多可输入 100 个用户组 ID。
	string	否	用户组 ID。取值来源： ListUserGroups ：批量查询用户组。 CreateUserGroup ：创建用户组。	usergroup-6f1ef2fc56b6****
Name	string	否	用户组名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	user_group_name
AttributeValue	string	否	用户组属性的值。长度为 1~128 个字符。	username
PAPolicyId	string	否	内网访问策略 ID。取值来源： ListPrivateAccessPolices ：批量查询内网访问策略。 CreatePrivateAccessPolicy ：创建内网访问策略。	pa-policy-54a7838a48bf****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	4AB972E2-D702-5464-B132-B1911498B8BF
TotalNum	integer	用户组的总数。	1
UserGroups	array<object>	用户组列表。
userGroup	object	用户组。
UserGroupId	string	用户组 ID。	usergroup-6f1ef2fc56b6****
Name	string	用户组名称。	user_group_name
Description	string	用户组描述。	这是一条用户组
Attributes	array<object>	用户组属性集合。多个用户组属性之间是或的关系，按照合集生效。
attribute	object	用户组属性。
UserGroupType	string	用户组的类型。取值： username：用户名。 department：部门。 email：邮箱。 telephone：手机。	department
Relation	string	用户组的关系。取值： Equal：等于。 Unequal：不等于。	Equal
Value	string	用户组属性的值。当用户组类型为 username 时，表示用户名的值。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。当用户组类型为 department 时，表示部门的值。如：OU=部门 1,OU=SASE 钉钉。当用户组类型为 email 时，表示邮箱的值。如：username@example.com。当用户组类型为 telephone 时，表示手机的值。如：13900001234。	OU=部门1,OU=SASE钉钉
IdpId	integer	用户组的身份源 ID。当自定义用户组类型为 department 时，存在该值。	12
CreateTime	string	用户组创建时间。	2022-10-10 11:39:22

示例

正常返回示例

JSON格式

{
  "RequestId": "4AB972E2-D702-5464-B132-B1911498B8BF",
  "TotalNum": 1,
  "UserGroups": [
    {
      "UserGroupId": "usergroup-6f1ef2fc56b6****",
      "Name": "user_group_name",
      "Description": "这是一条用户组",
      "Attributes": [
        {
          "UserGroupType": "department",
          "Relation": "Equal",
          "Value": "OU=部门1,OU=SASE钉钉",
          "IdpId": 12
        }
      ],
      "CreateTime": "2022-10-10 11:39:22"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-04-12	API 内部配置变更，不影响调用	查看变更详情