ListGroupsForUser - AWS Identity and Access Management

ListGroupsForUser

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

Request Syntax

{ "Marker": "string", "MaxItems": number, "UserName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Marker

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Required: No

MaxItems

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

UserName

The name of the user to list groups for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: Yes

Response Syntax

{ "Groups": [ { "Arn": "string", "CreateDate": number, "GroupId": "string", "GroupName": "string", "Path": "string" } ], "IsTruncated": boolean, "Marker": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Groups

A list of groups.

Type: Array of Group objects

IsTruncated

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

Type: Boolean

Marker

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

NoSuchEntityException

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 400

ServiceFailureException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListGroupsForUser.

Sample Request

https://iam.amazonaws.com/?Action=ListGroupsForUser &UserName=Bob &Version=2010-05-08 &AUTHPARAMS

Sample Response

<ListGroupsForUserResponse> <ListGroupsForUserResult> <Groups> <member> <Path>/</Path> <GroupName>Admins</GroupName> <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId> <Arn>arn:aws:iam::123456789012:group/Admins</Arn> </member> </Groups> <IsTruncated>false</IsTruncated> </ListGroupsForUserResult> <ResponseMetadata> <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId> </ResponseMetadata> </ListGroupsForUserResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: