ListGroupMembers - 查询用户组中的用户列表 - 云SSO

查询用户组中的用户列表。

接口说明

本文将提供一个示例，查询用户组g-00jqzghi2n3o5hkh****中的用户列表。返回结果显示，该用户组中一共有Alice和user1两个用户。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cloudsso:ListGroupMembers	list	*Group `acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId}`	无	无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	用户组 ID。	g-00jqzghi2n3o5hkh****
DirectoryId	string	是	目录 ID。	d-00fc2p61****
NextToken	string	否	查询返回结果下一页的令牌。首次调用 API 不需要`NextToken`。当您首次调用 API 时，如果返回数据总条数超过`MaxResults`限制，数据会被截断，只返回`MaxResults`条数据，同时，返回参数`IsTruncated`为`true`，返回一个`NextToken`。您可以使用上一次返回的`NextToken`继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到`IsTruncated`为`false`，表示全部数据查询完毕。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	否	每页的最大数据条数。取值范围：1~100。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
NextToken	string	查询返回结果下一页的令牌。说明只有`IsTruncated`为`true`时，才显示该参数。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	请求 ID。	BB759F84-2C64-5C36-B6C6-253172C5C370
TotalCounts	integer	符合请求参数条件的数据总条数。	2
MaxResults	integer	每页的最大数据条数。	10
IsTruncated	boolean	返回结果是否被截断。取值： true：已截断。 false：未截断。	false
GroupMembers	array<object>	用户组中的用户列表。
GroupMember	object	用户组中的用户列表。
Status	string	用户的状态。取值： Enabled：启用。 Disabled：禁用。	Enabled
UserName	string	用户名称。	Alice
Email	string	用户的电子邮箱。	AliceLee@example.com
Description	string	用户的描述。	This is a user.
UserId	string	用户 ID。	u-00q8wbq42wiltcrk****
ProvisionType	string	用户的类型。取值： Manual：手动创建。 Synchronized：外部同步。	Manual
DisplayName	string	用户的显示名称。	Alice
JoinTime	string	用户加入用户组的时间。	2021-11-01T06:58:18Z
GroupId	string	用户组 ID。	g-00jqzghi2n3o5hkh****

示例

正常返回示例

JSON格式

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "BB759F84-2C64-5C36-B6C6-253172C5C370",
  "TotalCounts": 2,
  "MaxResults": 10,
  "IsTruncated": false,
  "GroupMembers": [
    {
      "Status": "Enabled",
      "UserName": "Alice",
      "Email": "AliceLee@example.com",
      "Description": "This is a user.",
      "UserId": "u-00q8wbq42wiltcrk****",
      "ProvisionType": "Manual",
      "DisplayName": "Alice",
      "JoinTime": "2021-11-01T06:58:18Z",
      "GroupId": "g-00jqzghi2n3o5hkh****"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史