CognitoIdentityProvider / Client / list_user_pool_clients

list_user_pool_clients#

CognitoIdentityProvider.Client.list_user_pool_clients(**kwargs)#

Given a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more information, see App clients.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

See also: AWS API Documentation

Request Syntax

response = client.list_user_pool_clients(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool where you want to list user pool clients.

  • MaxResults (integer) – The maximum number of app clients that you want Amazon Cognito to return in the response.

  • NextToken (string) – This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Return type:

dict

Returns:

Response Syntax

{
    'UserPoolClients': [
        {
            'ClientId': 'string',
            'UserPoolId': 'string',
            'ClientName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Represents the response from the server that lists user pool clients.

    • UserPoolClients (list) –

      An array of app clients and their details. Includes app client ID and name.

      • (dict) –

        A short description of a user pool app client.

        • ClientId (string) –

          The app client ID.

        • UserPoolId (string) –

          The ID of the user pool that’s associated with the app client.

        • ClientName (string) –

          The app client name.

    • NextToken (string) –

      The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

Exceptions