SSOAdmin / Client / list_application_providers

list_application_providers

SSOAdmin.Client.list_application_providers(**kwargs)

Lists the application providers configured in the IAM Identity Center identity store.

See also: AWS API Documentation

Request Syntax

response = client.list_application_providers(
    MaxResults=123,
    NextToken='string'
)

Parameters:

• MaxResults (integer) – Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

• NextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s NextToken response to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationProviders': [
        {
            'ApplicationProviderArn': 'string',
            'DisplayData': {
                'Description': 'string',
                'DisplayName': 'string',
                'IconUrl': 'string'
            },
            'FederationProtocol': 'SAML'|'OAUTH',
            'ResourceServerConfig': {
                'Scopes': {
                    'string': {
                        'DetailedTitle': 'string',
                        'LongDescription': 'string'
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ApplicationProviders (list) –

    An array list of structures that describe application providers.

    • (dict) –

      A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

      • ApplicationProviderArn (string) –

        The ARN of the application provider.

      • DisplayData (dict) –

        A structure that describes how IAM Identity Center represents the application provider in the portal.

        • Description (string) –

          The description of the application provider that appears in the portal.

        • DisplayName (string) –

          The name of the application provider that appears in the portal.

        • IconUrl (string) –

          A URL that points to an icon that represents the application provider.

      • FederationProtocol (string) –

        The protocol that the application provider uses to perform federation.

      • ResourceServerConfig (dict) –

        A structure that describes the application provider’s resource server.

        • Scopes (dict) –

          A list of the IAM Identity Center access scopes that are associated with this resource server.

          • (string) –

            • (dict) –

              A structure that describes details for an IAM Identity Center access scope that is associated with a resource server.

              • DetailedTitle (string) –

                The title of an access scope for a resource server.

              • LongDescription (string) –

                The description of an access scope for a resource server.

  • NextToken (string) –

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Exceptions

• SSOAdmin.Client.exceptions.ThrottlingException

• SSOAdmin.Client.exceptions.InternalServerException

• SSOAdmin.Client.exceptions.AccessDeniedException

• SSOAdmin.Client.exceptions.ValidationException