WorkSpacesWeb / Client / get_identity_provider

get_identity_provider#

WorkSpacesWeb.Client.get_identity_provider(**kwargs)#

Gets the identity provider.

See also: AWS API Documentation

Request Syntax

response = client.get_identity_provider(
    identityProviderArn='string'
)
Parameters:

identityProviderArn (string) –

[REQUIRED]

The ARN of the identity provider.

Return type:

dict

Returns:

Response Syntax

{
    'identityProvider': {
        'identityProviderArn': 'string',
        'identityProviderDetails': {
            'string': 'string'
        },
        'identityProviderName': 'string',
        'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
    }
}

Response Structure

  • (dict) –

    • identityProvider (dict) –

      The identity provider.

      • identityProviderArn (string) –

        The ARN of the identity provider.

      • identityProviderDetails (dict) –

        The identity provider details. The following list describes the provider detail keys for each identity provider type.

        • For Google and Login with Amazon:

          • client_id

          • client_secret

          • authorize_scopes

        • For Facebook:

          • client_id

          • client_secret

          • authorize_scopes

          • api_version

        • For Sign in with Apple:

          • client_id

          • team_id

          • key_id

          • private_key

          • authorize_scopes

        • For OIDC providers:

          • client_id

          • client_secret

          • attributes_request_method

          • oidc_issuer

          • authorize_scopes

          • authorize_url if not available from discovery URL specified by oidc_issuer key

          • token_url if not available from discovery URL specified by oidc_issuer key

          • attributes_url if not available from discovery URL specified by oidc_issuer key

          • jwks_uri if not available from discovery URL specified by oidc_issuer key

        • For SAML providers:

          • MetadataFile OR MetadataURL

          • IDPSignout (boolean) optional

          • IDPInit (boolean) optional

          • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

          • EncryptedResponses (boolean) optional

        • (string) –

          • (string) –

      • identityProviderName (string) –

        The identity provider name.

      • identityProviderType (string) –

        The identity provider type.

Exceptions