Query CloudSSO Group Members via ListGroupMembers API - CloudSSO - Alibaba Cloud - CloudSSO

Queries the users in a group.

Operation description

The following example queries the users in the group g-00jqzghi2n3o5hkh****. The response shows that the group contains two users: Alice and user1.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:ListGroupMembers

list

*Group

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId}

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 for the next page of results. Leave this parameter empty for the first request. For subsequent requests, use the `NextToken` value returned in the previous response. If the total number of entries exceeds the `MaxResults` value, the response is truncated: `IsTruncated` is set to `true` and a `NextToken` value is returned. Pass this `NextToken` in the next request with the same parameters to retrieve the remaining entries. Repeat until `IsTruncated` is `false`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	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 response is truncated. Valid values: true: The returned results are truncated. false: The returned results are not truncated.	false
GroupMembers	array<object>	The users in the group.
	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, in the ISO 8601 `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2021-11-01T06:58:18Z
GroupId	string	The ID of the group.	g-00jqzghi2n3o5hkh****

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.