SSOAdmin / Client / create_trusted_token_issuer

create_trusted_token_issuer#

SSOAdmin.Client.create_trusted_token_issuer(**kwargs)#

Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services.

This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.

See also: AWS API Documentation

Request Syntax

response = client.create_trusted_token_issuer(
    ClientToken='string',
    InstanceArn='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TrustedTokenIssuerConfiguration={
        'OidcJwtConfiguration': {
            'ClaimAttributePath': 'string',
            'IdentityStoreAttributePath': 'string',
            'IssuerUrl': 'string',
            'JwksRetrievalOption': 'OPEN_ID_DISCOVERY'
        }
    },
    TrustedTokenIssuerType='OIDC_JWT'
)
Parameters:

  • ClientToken (string) –

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don’t provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    This field is autopopulated if not provided.

  • InstanceArn (string) –

    [REQUIRED]

    Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.

  • Name (string) –

    [REQUIRED]

    Specifies the name of the new trusted token issuer configuration.

  • Tags (list) –

    Specifies tags to be attached to the new trusted token issuer configuration.

    • (dict) –

      A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in Amazon Web Services accounts.

      • Key (string) – [REQUIRED]

        The key for the tag.

      • Value (string) – [REQUIRED]

        The value of the tag.

  • TrustedTokenIssuerConfiguration (dict) –

    [REQUIRED]

    Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType you specify.

    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 the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT).

      • ClaimAttributePath (string) – [REQUIRED]

        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) – [REQUIRED]

        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) – [REQUIRED]

        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) – [REQUIRED]

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

  • TrustedTokenIssuerType (string) –

    [REQUIRED]

    Specifies the type of the new trusted token issuer.

Return type:

dict

Returns:

Response Syntax

{
    'TrustedTokenIssuerArn': 'string'
}

Response Structure

  • (dict) –

    • TrustedTokenIssuerArn (string) –

      The ARN of the new trusted token issuer configuration.

Exceptions