j9九游会登录/ 统一身份认证服务 iam_统一身份认证服务（新版）/ api参考/ / / / 查询用户组相关属性 - showgroupsummary
更新时间：2025-12-25 gmt 08:00
查看pdf

查询用户组相关属性 -j9九游会登录

功能介绍

该接口可以用于查询用户组相关属性。

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

授权信息

账号根用户具备所有api的调用权限，如果使用账号下的iam用户调用当前api，该iam用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

iam:groups:listgroupsv5

list

group *

-

-

-

uri

get /v5/groups-summary

表1 query参数

参数

是否必选

参数类型

描述

limit

否

integer

每页显示的条目数量，范围为1到200条，默认为100条。

最小值：1

最大值：200

缺省值：100

marker

否

string

分页标记，长度为4到400个字符，只包含字母、数字、" "、"/"、"="、"-"和"_"的字符串。

最小长度：4

最大长度：400

user_id

否

string

iam用户id。

请求参数

无

响应参数

状态码：200

表2 响应body参数

参数

参数类型

描述

groups

array of groupsummary objects

用户组列表。

数组长度：0 - 5000

page_info

pageinfo object

分页信息。
表3 groupsummary

参数

参数类型

描述

group_id

string

用户组id。

group_name

string

用户组名，长度为1到128个字符，可包含中文、英文、数字、空格、"_"、"-"、"{"和"}"的字符串。

created_at

string

用户组创建时间。

urn

string

统一资源名称。

description

string

用户组描述信息，长度为0到255字符，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。

user_count

integer

用户数量。

最小值：0

最大值：5000
表4 pageinfo

参数

参数类型

描述

next_marker

string

如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。

current_count

integer

本页返回条目数量。

状态码：400

表5 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

状态码：403

表6 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

request_id

string

请求id。

encoded_authorization_message

string

加密后的认证失败信息，可以通过sts5解密接口进行解密。

请求示例

  • 查询所有用户组属性。

    get https://{endpoint}/v5/groups-summary

  • 查询iam用户xxx所在的所有用户组列表。

    get https://{endpoint}/v5/groups-summary?user_id=xxx

响应示例

状态码：200

请求成功。

{
  "groups" : [ {
    "group_id" : "string",
    "group_name" : "name",
    "created_at" : "2023-09-11t10:13:25.414z",
    "urn" : "iam::accountid:group:name",
    "description" : "description",
    "user_count" : 100
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

403

没有操作权限。

错误码

请参见错误码。

父主题：

相关文档

网站地图