SSOAdmin / Client / update_trusted_token_issuer

update_trusted_token_issuer#

SSOAdmin.Client.update_trusted_token_issuer(**kwargs)#

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.

Note

Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.

See also: AWS API Documentation

Request Syntax

response = client.update_trusted_token_issuer(
    Name='string',
    TrustedTokenIssuerArn='string',
    TrustedTokenIssuerConfiguration={
        'OidcJwtConfiguration': {
            'ClaimAttributePath': 'string',
            'IdentityStoreAttributePath': 'string',
            'JwksRetrievalOption': 'OPEN_ID_DISCOVERY'
        }
    }
)
Parameters:

  • Name (string) – Specifies the updated name to be applied to the trusted token issuer configuration.

  • TrustedTokenIssuerArn (string) –

    [REQUIRED]

    Specifies the ARN of the trusted token issuer configuration that you want to update.

  • TrustedTokenIssuerConfiguration (dict) –

    Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: OidcJwtConfiguration.

    • OidcJwtConfiguration (dict) –

      A structure that describes an updated configuration for a trusted token issuer that uses OpenID Connect (OIDC) with 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.

      • JwksRetrievalOption (string) –

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException

  • SSOAdmin.Client.exceptions.ConflictException