SSOAdmin / Client / describe_application_provider

describe_application_provider

SSOAdmin.Client.describe_application_provider(**kwargs)

Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_provider(
    ApplicationProviderArn='string'
)

Parameters:

ApplicationProviderArn (string) –

[REQUIRED]

Specifies the ARN of the application provider for which you want details.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • ApplicationProviderArn (string) –

    The ARN of the application provider.

  • DisplayData (dict) –

    A structure with details about the display data for the application provider.

    • 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 used to federate to the application provider.

  • ResourceServerConfig (dict) –

    A structure with details about the receiving application.

    • 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.

Exceptions

• SSOAdmin.Client.exceptions.ThrottlingException

• SSOAdmin.Client.exceptions.InternalServerException

• SSOAdmin.Client.exceptions.ResourceNotFoundException

• SSOAdmin.Client.exceptions.AccessDeniedException

• SSOAdmin.Client.exceptions.ValidationException