ListGroupMembers - CloudSSO - Alibaba Cloud Documentation Center

Queries the users in a group.

Operation description

This topic provides an example on how to query the users in the group g-00jqzghi2n3o5hkh****. The returned result shows that the group contains the user Alice and the user user1.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:ListGroupMembers	list	*Group `acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the group.	g-00jqzghi2n3o5hkh****
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`. When you call this operation for the first time, if the total number of entries to return is larger than the value of the `MaxResults` parameter, the entries are truncated. The system returns entries based on the value of the `MaxResults` parameter, and does not return the excess entries. In this case, the value of the response parameter `IsTruncated` is `true`, and the `NextToken` parameter is returned. In the next call, you can use the value of the `NextToken` parameter and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Note This parameter is returned only when the value of the `IsTruncated` parameter is `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	The request ID.	BB759F84-2C64-5C36-B6C6-253172C5C370
TotalCounts	integer	The total number of entries returned.	2
MaxResults	integer	The number of entries per page.	10
IsTruncated	boolean	Indicates whether the queried entries are truncated. Valid values: true false	false
GroupMembers	array<object>	The users in the group.
GroupMember	object	The user in the group.
Status	string	The status of the user. Valid values: Enabled: The logon of the user is enabled. Disabled: The logon of the user is disabled.	Enabled
UserName	string	The name of the user.	Alice
Email	string	The email address of the user.	AliceLee@example.com
Description	string	The description of the user.	This is a user.
UserId	string	The ID of the user.	u-00q8wbq42wiltcrk****
ProvisionType	string	The type of the user. Valid values: Manual: The user is manually created. Synchronized: The user is synchronized from an external identity provider (IdP).	Manual
DisplayName	string	The display name of the user.	Alice
JoinTime	string	The time when the user was added to the group.	2021-11-01T06:58:18Z
GroupId	string	The ID of the group.	g-00jqzghi2n3o5hkh****

Examples

Sample success responses

JSONformat

{
  "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****"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history