SSOAdmin / Client / describe_trusted_token_issuer

describe_trusted_token_issuer#

SSOAdmin.Client.describe_trusted_token_issuer(**kwargs)#

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_token_issuer(
    TrustedTokenIssuerArn='string'
)
Parameters:

TrustedTokenIssuerArn (string) –

[REQUIRED]

Specifies the ARN of the trusted token issuer configuration that you want details about.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'TrustedTokenIssuerArn': 'string',
    'TrustedTokenIssuerConfiguration': {
        'OidcJwtConfiguration': {
            'ClaimAttributePath': 'string',
            'IdentityStoreAttributePath': 'string',
            'IssuerUrl': 'string',
            'JwksRetrievalOption': 'OPEN_ID_DISCOVERY'
        }
    },
    'TrustedTokenIssuerType': 'OIDC_JWT'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the trusted token issuer configuration.

    • TrustedTokenIssuerArn (string) –

      The ARN of the trusted token issuer configuration.

    • TrustedTokenIssuerConfiguration (dict) –

      A structure the describes the settings that apply of this trusted token issuer.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: OidcJwtConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • OidcJwtConfiguration (dict) –

        A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT).

        • ClaimAttributePath (string) –

          The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

        • IdentityStoreAttributePath (string) –

          The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

        • IssuerUrl (string) –

          The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

        • JwksRetrievalOption (string) –

          The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

    • TrustedTokenIssuerType (string) –

      The type of the trusted token issuer.

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException