CloudSSO:ListJoinedGroupsForUser - CloudSSO - Alibaba Cloud - CloudSSO

Queries the groups to which a user is added.

Operation description

This topic provides an example on how to query the groups to which the user u-00q8wbq42wiltcrk**** is added. The returned result shows that the user is added to both the TestGroup and the group1 groups.

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:ListJoinedGroupsForUser

list

*User

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/{#UserId}

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user.	u-00q8wbq42wiltcrk****
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 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 `IsTruncated` parameter is `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	The request ID.	E9BBB45F-7877-5DE9-96A5-20E6CFA48929
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: The returned results are truncated. false: The returned results are not truncated.	false
JoinedGroups	array<object>	The groups to which the user is added.
	object	The group to which the user is added.
GroupName	string	The name of the group.	TestGroup
Description	string	The description of the group.	This is a group.
UserId	string	The ID of the user.	u-00q8wbq42wiltcrk****
ProvisionType	string	The type of the group. Valid values: Manual: The group is manually created. Synchronized: The group is synchronized from an external identity provider (IdP).	Manual
JoinTime	string	The time when the user was added to the group. The value is in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2021-11-01T06:58:18Z
GroupId	string	The ID of the group.	g-00jqzghi2n3o5hkh****

Examples

Success response

JSON format

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "E9BBB45F-7877-5DE9-96A5-20E6CFA48929",
  "TotalCounts": 2,
  "MaxResults": 10,
  "IsTruncated": false,
  "JoinedGroups": [
    {
      "GroupName": "TestGroup",
      "Description": "This is a group.",
      "UserId": "u-00q8wbq42wiltcrk****",
      "ProvisionType": "Manual",
      "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.