CognitoIdentityProvider / Client / list_resource_servers

list_resource_servers#

CognitoIdentityProvider.Client.list_resource_servers(**kwargs)#

Given a user pool ID, returns all resource servers and their details. For more information about resource servers, see Access control with resource servers.

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_resource_servers(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • UserPoolId (string) –

    [REQUIRED]

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

  • MaxResults (integer) – The maximum number of resource servers 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

{
    'ResourceServers': [
        {
            'UserPoolId': 'string',
            'Identifier': 'string',
            'Name': 'string',
            'Scopes': [
                {
                    'ScopeName': 'string',
                    'ScopeDescription': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ResourceServers (list) –

      An array of resource servers and the details of their configuration. For each, the response includes names, identifiers, and custom scopes.

      • (dict) –

        The details of a resource server configuration and associated custom scopes in a user pool.

        • UserPoolId (string) –

          The ID of the user pool that contains the resource server configuration.

        • Identifier (string) –

          A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

          Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

        • Name (string) –

          The name of the resource server.

        • Scopes (list) –

          A list of scopes that are defined for the resource server.

          • (dict) –

            One custom scope associated with a user pool resource server. This data type is a member of ResourceServerScopeType. For more information, see Scopes, M2M, and API authorization with resource servers.

            • ScopeName (string) –

              The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName. For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer, you request and receive the scope exampleResourceServer/exampleScope.

            • ScopeDescription (string) –

              A friendly description of a custom scope.

    • 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