trusted_token_issuers

Creates, updates, deletes, gets or lists a trusted_token_issuers resource.

Overview

Name	trusted_token_issuers
Type	Resource
Id	aws.sso_admin.trusted_token_issuers

Fields

The following fields are returned by SELECT queries:

describe_trusted_token_issuer

Name	Datatype	Description
name	string	The name of the trusted token issuer configuration. (pattern: <code>[\w+=,.@-]+</code>)
trusted_token_issuer_arn	string	The ARN of the trusted token issuer configuration. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
trusted_token_issuer_configuration	object	A structure the describes the settings that apply of this trusted token issuer.
trusted_token_issuer_type	string	The type of the trusted token issuer. (OIDC_JWT)

list_trusted_token_issuers

Name	Datatype	Description
name	string	The name of the trusted token issuer configuration in the instance of IAM Identity Center. (pattern: <code>[\w+=,.@-]+</code>)
trusted_token_issuer_arn	string	The ARN of the trusted token issuer configuration in the instance of IAM Identity Center. (pattern: <code>arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
trusted_token_issuer_type	string	The type of trusted token issuer. (OIDC_JWT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_trusted_token_issuer	select	region		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.
list_trusted_token_issuers	select	region		Lists all the trusted token issuers configured in an instance of IAM Identity Center.
create_trusted_token_issuer	insert	region, InstanceArn, TrustedTokenIssuerType, TrustedTokenIssuerConfiguration		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.
update_trusted_token_issuer	update	region, TrustedTokenIssuerArn		Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration. Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.
delete_trusted_token_issuer	delete	region		Deletes a trusted token issuer configuration from an instance of IAM Identity Center. Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_trusted_token_issuer

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.

SELECT
name,
trusted_token_issuer_arn,
trusted_token_issuer_configuration,
trusted_token_issuer_type
FROM aws.sso_admin.trusted_token_issuers
WHERE region = '{{ region }}' -- required
;

list_trusted_token_issuers

Lists all the trusted token issuers configured in an instance of IAM Identity Center.

SELECT
name,
trusted_token_issuer_arn,
trusted_token_issuer_type
FROM aws.sso_admin.trusted_token_issuers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_trusted_token_issuer

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.

INSERT INTO aws.sso_admin.trusted_token_issuers (
InstanceArn,
Name,
TrustedTokenIssuerType,
TrustedTokenIssuerConfiguration,
ClientToken,
Tags,
region
)
SELECT 
'{{ InstanceArn }}' /* required */,
'{{ Name }}',
'{{ TrustedTokenIssuerType }}' /* required */,
'{{ TrustedTokenIssuerConfiguration }}' /* required */,
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
trusted_token_issuer_arn
;

Manifest

# Description fields are for documentation purposes
- name: trusted_token_issuers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the trusted_token_issuers resource.
  - name: InstanceArn
    value: "{{ InstanceArn }}"
    description: |
      Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.
  - name: Name
    value: "{{ Name }}"
    description: |
      Specifies the name of the new trusted token issuer configuration.
  - name: TrustedTokenIssuerType
    value: "{{ TrustedTokenIssuerType }}"
    description: |
      Specifies the type of the new trusted token issuer.
    valid_values: ['OIDC_JWT']
  - name: TrustedTokenIssuerConfiguration
    description: |
      Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType you specify.
    value:
      OidcJwtConfiguration:
        IssuerUrl: "{{ IssuerUrl }}"
        ClaimAttributePath: "{{ ClaimAttributePath }}"
        IdentityStoreAttributePath: "{{ IdentityStoreAttributePath }}"
        JwksRetrievalOption: "{{ JwksRetrievalOption }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.
  - name: Tags
    description: |
      Specifies tags to be attached to the new trusted token issuer configuration.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_trusted_token_issuer

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration. Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.

UPDATE aws.sso_admin.trusted_token_issuers
SET 
TrustedTokenIssuerArn = '{{ TrustedTokenIssuerArn }}',
Name = '{{ Name }}',
TrustedTokenIssuerConfiguration = '{{ TrustedTokenIssuerConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND TrustedTokenIssuerArn = '{{ TrustedTokenIssuerArn }}' --required;

DELETE examples

delete_trusted_token_issuer

Deletes a trusted token issuer configuration from an instance of IAM Identity Center. Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.

DELETE FROM aws.sso_admin.trusted_token_issuers
WHERE region = '{{ region }}' --required
;