调用ListGroups查询用户组列表。
接口说明
本文将提供一个示例,查询目录d-00fc2p61****
下的用户组列表。返回结果显示,该目录下一共存在 3 个用户组,其中group1
和group2
是从外部同步的用户组,TestGroup
是云 SSO 内部手动创建的用户组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cloudsso:ListGroups | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DirectoryId | string | 是 | 目录 ID。 | d-00fc2p61**** |
NextToken | string | 否 | 查询返回结果下一页的令牌。首次调用 API 不需要 当您首次调用 API 时,如果返回数据总条数超过 | K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
MaxResults | integer | 否 | 每页的最大数据条数。 取值范围:1~100。 默认值:10。 | 10 |
Filter | string | 否 | 过滤条件。 格式: 示例:Filter = "GroupName sw test",表示查询名称以 test 开头的全部用户组。Filter = "GroupName eq testgroup",表示查询名称为 testgroup 的用户组。 | GroupName eq testgroup |
ProvisionType | string | 否 | 用户组的类型,用于查询的过滤条件。取值:
| Manual |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
"RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3",
"Groups": [
{
"GroupName": "TestGroup",
"Description": "This is a group.",
"CreateTime": "2021-11-01T02:38:27Z",
"ProvisionType": "Manual",
"UpdateTime": "2021-11-01T02:38:27Z",
"GroupId": "g-00jqzghi2n3o5hkh****"
}
],
"MaxResults": 10,
"TotalCounts": 3,
"IsTruncated": false
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|