IdentityStore / Client / list_groups

list_groups¶

IdentityStore.Client.list_groups(**kwargs)¶

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

Note

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Request Syntax

response = client.list_groups(
    IdentityStoreId='string',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'AttributePath': 'string',
            'AttributeValue': 'string'
        },
    ]
)

Parameters:

IdentityStoreId (string) –
[REQUIRED]

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.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
MaxResults (integer) – The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
NextToken (string) – 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 retrieve the next page of results.
Filters (list) –
A list of Filter objects, which is used in the ListUsers and ListGroups requests.
- (dict) –
  
  A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.
  - AttributePath (string) – [REQUIRED]
    
    The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
  - AttributeValue (string) – [REQUIRED]
    
    Represents the data for an attribute. Each attribute value is described as a name-value pair.

Return type:

dict

Returns:

Response Syntax

{
    'Groups': [
        {
            'IdentityStoreId': 'string',
            'GroupId': 'string',
            'GroupArn': 'string',
            'Revision': 'string',
            'DisplayName': 'string',
            'ExternalIds': [
                {
                    'Issuer': 'string',
                    'Id': 'string'
                },
            ],
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'UpdatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Groups (list) –
  
  A list of Group objects in the identity store.
  - (dict) –
    
    A group object that contains the metadata and attributes for a specified group.
    - IdentityStoreId (string) –
      
      The globally unique identifier for the identity store.
    - GroupId (string) –
      
      The identifier for a group in the identity store.
    - GroupArn (string) –
      
      The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
    - Revision (string) –
      
      The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the Revision parameter of an UpdateGroup or DeleteGroup request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don’t parse it or rely on its format or ordering.
    - DisplayName (string) –
      
      The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
      
      Prefix search supports a maximum of 1,000 characters for the string.
    - ExternalIds (list) –
      
      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
      - (dict) –
        
        The identifier issued to this resource by an external identity provider.
        
        Issuer (string) –
        
        The issuer for an external identifier.
        
        Id (string) –
        
        The identifier issued to this resource by an external identity provider.
    - Description (string) –
      
      A string containing a description of the specified group.
    - CreatedAt (datetime) –
      
      The date and time the group was created.
    - UpdatedAt (datetime) –
      
      The date and time the group was last updated.
    - CreatedBy (string) –
      
      The identifier of the user or system that created the group.
    - UpdatedBy (string) –
      
      The identifier of the user or system that last updated the group.
- NextToken (string) –
  
  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 retrieve the next page of results.

Exceptions

IdentityStore.Client.exceptions.ResourceNotFoundException
IdentityStore.Client.exceptions.ThrottlingException
IdentityStore.Client.exceptions.AccessDeniedException
IdentityStore.Client.exceptions.InternalServerException
IdentityStore.Client.exceptions.ValidationException