Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListGroups

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

This parameter has been deprecated.

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

Type: Array of Filter objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

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 numbers 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 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

MaxResults

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests 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 100.

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": [ 
      { 
         "Description": "string",
         "DisplayName": "string",
         "ExternalIds": [ 
            { 
               "Id": "string",
               "Issuer": "string"
            }
         ],
         "GroupId": "string",
         "IdentityStoreId": "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.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

InternalServerException

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

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
ResourceId: The identifier for a resource in the identity store that can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.
ResourceType: An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.

HTTP Status Code: 400

ThrottlingException

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

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

Examples

Example

This example lists the two groups in the specified identity store.

Sample Request


{
    "IdentityStoreId": "d-1234567890",
    "MaxResults": 100,
    "NextToken": "",
}

Sample Response


{
    "Groups": [
        {
            "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "DisplayName": "Developers",
            "Description": "Group that contains all developers",
            "IdentityStoreId": "d-1234567890"
        },
        {
            "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "DisplayName": "Engineers",
            "Description": "Group that contains all engineers",
            "IdentityStoreId": "d-1234567890"
        }
    ]
}