ListGroups - AWS SSO Identity Store

ListGroups

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

Request Syntax

{ "Filters": [ { "AttributePath": "string", "AttributeValue": "string" } ], "IdentityStoreId": "string", "MaxResults": number, "NextToken": "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.

Filters

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Type: Array of Filter objects

Required: Yes

IdentityStoreId

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

Type: String

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

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

MaxResults

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Type: Integer

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

Required: No

NextToken

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Type: String

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

Pattern: ^[-a-zA-Z0-9+=/:]*

Required: No

Response Syntax

{ "Groups": [ { "DisplayName": "string", "GroupId": "string" } ], "NextToken": "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 Group objects in the identity store.

Type: Array of Group objects

NextToken

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

Type: String

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

Pattern: ^[-a-zA-Z0-9+=/:]*

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400

See Also

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