AWS Identity and Access Management

2026/11/19 - AWS Identity and Access Management - 1 new 7 updated api methods

Changes  This release adds API support for configuring trusted identity propagation for IAM SAML and OpenIDConnect providers.

UpdateOpenIDConnectProvider (new) Link ¶

Updates the configuration of an existing IAM OpenID Connect (OIDC) identity provider resource object. Use this operation to set, change, or remove the trusted identity propagation context provider, and to associate or disassociate an IAM Identity Center instance with the provider.

To remove a configuration rather than replace it, use the RemoveContextProvider and RemoveIdentityCenterInstance parameters. For each configuration, provide either the new value or the corresponding Remove flag in a single request, but not both. For example, specifying both ContextProvider and RemoveContextProvider in the same request is not allowed.

A single request can change either the context provider or the IAM Identity Center association, but not both. To change both, make separate UpdateOpenIDConnectProvider requests. To remove the context provider, first remove the IAM Identity Center association in a separate request.

To control who can configure trusted identity propagation on an OIDC provider, use the iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM policies. The Request keys contain the values in the request. The Resource keys contain the values stored on the provider.

See also: AWS API Documentation

Request Syntax

client.update_open_id_connect_provider(
    OpenIDConnectProviderArn='string',
    ContextProvider={
        'KeyDefinitionList': [
            {
                'SourceKey': 'string',
                'TargetKey': 'string'
            },
        ],
        'SubjectSourceKey': 'string',
        'SubjectTypeValue': 'string',
        'SubjectTypeSourceKey': 'string'
    },
    IdentityCenterInstanceArn='string',
    RemoveContextProvider=True|False,
    RemoveIdentityCenterInstance=True|False
)
type OpenIDConnectProviderArn:

string

param OpenIDConnectProviderArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

type ContextProvider:

dict

param ContextProvider:

The trusted identity propagation context provider configuration to set on the OIDC provider. This configuration defines the subject mapping and the source-to-target key mappings that are used when trusted context is injected. For more information, see ContextProvider.

To remove the existing context provider instead of replacing it, use RemoveContextProvider. Do not specify both ContextProvider and RemoveContextProvider in the same request.

  • KeyDefinitionList (list) --

    A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

    • (dict) --

      Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

      This data type is used as a member of the ContextProvider data type.

      • SourceKey (string) -- [REQUIRED]

        The key in the external identity provider's assertion or token to read the value from.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • TargetKey (string) --

        The trusted context key to map the source value into.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectSourceKey (string) -- [REQUIRED]

    The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectTypeValue (string) --

    A static value for the subject type, such as user or workload.

    This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

  • SubjectTypeSourceKey (string) --

    The source key that supplies the subject type from the external identity provider's assertion or token.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

    This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

type IdentityCenterInstanceArn:

string

param IdentityCenterInstanceArn:

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the OIDC provider.

For the format, see InstanceMetadata in the IAM Identity Center API Reference.

To disassociate the currently associated instance instead of changing it, use RemoveIdentityCenterInstance. Do not specify both IdentityCenterInstanceArn and RemoveIdentityCenterInstance in the same request.

type RemoveContextProvider:

boolean

param RemoveContextProvider:

Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this value to true to remove the context provider.

This parameter is mutually exclusive with ContextProvider. In a single request, specify either a new ContextProvider value or RemoveContextProvider, but not both.

type RemoveIdentityCenterInstance:

boolean

param RemoveIdentityCenterInstance:

Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider. Set this value to true to remove the association.

This parameter is mutually exclusive with IdentityCenterInstanceArn. In a single request, specify either a new IdentityCenterInstanceArn value or RemoveIdentityCenterInstance, but not both.

returns:

None

CreateOpenIDConnectProvider (updated) Link ¶
Changes (request)
{'ContextProvider': {'KeyDefinitionList': [{'SourceKey': 'string',
                                            'TargetKey': 'string'}],
                     'SubjectSourceKey': 'string',
                     'SubjectTypeSourceKey': 'string',
                     'SubjectTypeValue': 'string'},
 'IdentityCenterInstanceArn': 'string'}

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.

If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.

When you create the IAM OIDC provider, you specify the following:

  • The URL of the OIDC identity provider (IdP) to trust

  • A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider

  • A list of tags that are attached to the specified IAM OIDC provider

  • A list of thumbprints of one or more server certificates that the IdP uses

  • A trusted identity propagation context provider that defines how the subject is derived and how keys from the provider's token are mapped into trusted context keys. Specifying a context provider enables trusted identity propagation for the provider. For more information, see ContextProvider.

  • The ARN of an IAM Identity Center instance to associate with the OIDC provider. If you specify an IAM Identity Center instance, you must also specify a context provider.

You get the URL, client IDs, and thumbprints from the OIDC IdP you want to use to access Amazon Web Services.

To control who can configure trusted identity propagation on an OIDC provider, use the iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:RequestIdentityProviderIssuers, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM policies. The Request keys contain the values in the request. The Resource keys contain the values stored on the provider.

See also: AWS API Documentation

Request Syntax

client.create_open_id_connect_provider(
    Url='string',
    ClientIDList=[
        'string',
    ],
    ThumbprintList=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ContextProvider={
        'KeyDefinitionList': [
            {
                'SourceKey': 'string',
                'TargetKey': 'string'
            },
        ],
        'SubjectSourceKey': 'string',
        'SubjectTypeValue': 'string',
        'SubjectTypeSourceKey': 'string'
    },
    IdentityCenterInstanceArn='string'
)
type Url:

string

param Url:

[REQUIRED]

The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.

You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.

type ClientIDList:

list

param ClientIDList:

Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. This is the value that's sent as the client_id parameter on OAuth requests.

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.

  • (string) --

type ThumbprintList:

list

param ThumbprintList:

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

This parameter is optional. If it is not included, IAM will retrieve and use the top intermediate certificate authority (CA) thumbprint of the OpenID Connect identity provider server certificate.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.

  • (string) --

    Contains a thumbprint for an identity provider's server certificate.

    The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is used by the domain where the OpenID Connect provider makes its keys available. The thumbprint is always a 40-character string.

type Tags:

list

param Tags:

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • (dict) --

    A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

    • Key (string) -- [REQUIRED]

      The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

    • Value (string) -- [REQUIRED]

      The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

type ContextProvider:

dict

param ContextProvider:

The trusted identity propagation context provider configuration to associate with the OpenID Connect (OIDC) provider. The context provider defines how the subject is derived and how keys from the provider's token are mapped into trusted context keys. Specifying a context provider enables trusted identity propagation for the provider. For more information, see ContextProvider.

  • KeyDefinitionList (list) --

    A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

    • (dict) --

      Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

      This data type is used as a member of the ContextProvider data type.

      • SourceKey (string) -- [REQUIRED]

        The key in the external identity provider's assertion or token to read the value from.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • TargetKey (string) --

        The trusted context key to map the source value into.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectSourceKey (string) -- [REQUIRED]

    The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectTypeValue (string) --

    A static value for the subject type, such as user or workload.

    This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

  • SubjectTypeSourceKey (string) --

    The source key that supplies the subject type from the external identity provider's assertion or token.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

    This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

type IdentityCenterInstanceArn:

string

param IdentityCenterInstanceArn:

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the OpenID Connect (OIDC) provider. If you specify this parameter, you must also specify ContextProvider.

For the format, see InstanceMetadata in the IAM Identity Center API Reference.

rtype:

dict

returns:

Response Syntax

{
    'OpenIDConnectProviderArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Contains the response to a successful CreateOpenIDConnectProvider request.

    • OpenIDConnectProviderArn (string) --

      The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

    • Tags (list) --

      A list of tags that are attached to the new IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      • (dict) --

        A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Key (string) --

          The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

        • Value (string) --

          The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

CreateSAMLProvider (updated) Link ¶
Changes (request)
{'ContextProvider': {'KeyDefinitionList': [{'SourceKey': 'string',
                                            'TargetKey': 'string'}],
                     'SubjectSourceKey': 'string',
                     'SubjectTypeSourceKey': 'string',
                     'SubjectTypeValue': 'string'},
 'IdentityCenterInstanceArn': 'string'}

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.

To control who can configure trusted identity propagation on a SAML provider, use the iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:RequestIdentityProviderIssuers, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM policies. The Request keys contain the values in the request. The Resource keys contain the values stored on the provider.

See also: AWS API Documentation

Request Syntax

client.create_saml_provider(
    SAMLMetadataDocument='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AssertionEncryptionMode='Required'|'Allowed',
    AddPrivateKey='string',
    ContextProvider={
        'KeyDefinitionList': [
            {
                'SourceKey': 'string',
                'TargetKey': 'string'
            },
        ],
        'SubjectSourceKey': 'string',
        'SubjectTypeValue': 'string',
        'SubjectTypeSourceKey': 'string'
    },
    IdentityCenterInstanceArn='string'
)
type SAMLMetadataDocument:

string

param SAMLMetadataDocument:

[REQUIRED]

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based federation in the IAM User Guide

type Name:

string

param Name:

[REQUIRED]

The name of the provider to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

type Tags:

list

param Tags:

A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • (dict) --

    A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

    • Key (string) -- [REQUIRED]

      The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

    • Value (string) -- [REQUIRED]

      The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

type AssertionEncryptionMode:

string

param AssertionEncryptionMode:

Specifies the encryption setting for the SAML provider.

type AddPrivateKey:

string

param AddPrivateKey:

The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

type ContextProvider:

dict

param ContextProvider:

The trusted identity propagation context provider configuration to associate with the SAML provider. The context provider defines how the subject is derived and how keys from the provider's SAML assertion are mapped into trusted context keys. Specifying a context provider enables trusted identity propagation for the provider. For more information, see ContextProvider.

  • KeyDefinitionList (list) --

    A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

    • (dict) --

      Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

      This data type is used as a member of the ContextProvider data type.

      • SourceKey (string) -- [REQUIRED]

        The key in the external identity provider's assertion or token to read the value from.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • TargetKey (string) --

        The trusted context key to map the source value into.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectSourceKey (string) -- [REQUIRED]

    The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectTypeValue (string) --

    A static value for the subject type, such as user or workload.

    This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

  • SubjectTypeSourceKey (string) --

    The source key that supplies the subject type from the external identity provider's assertion or token.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

    This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

type IdentityCenterInstanceArn:

string

param IdentityCenterInstanceArn:

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the SAML provider. If you specify this parameter, you must also specify ContextProvider.

For the format, see InstanceMetadata in the IAM Identity Center API Reference.

rtype:

dict

returns:

Response Syntax

{
    'SAMLProviderArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Contains the response to a successful CreateSAMLProvider request.

    • SAMLProviderArn (string) --

      The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

    • Tags (list) --

      A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      • (dict) --

        A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Key (string) --

          The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

        • Value (string) --

          The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

GetOpenIDConnectProvider (updated) Link ¶
Changes (response)
{'ContextProvider': {'KeyDefinitionList': [{'SourceKey': 'string',
                                            'TargetKey': 'string'}],
                     'SubjectSourceKey': 'string',
                     'SubjectTypeSourceKey': 'string',
                     'SubjectTypeValue': 'string'},
 'IdentityCenterInstanceArn': 'string',
 'IdentityStoreArn': 'string'}

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

See also: AWS API Documentation

Request Syntax

client.get_open_id_connect_provider(
    OpenIDConnectProviderArn='string'
)
type OpenIDConnectProviderArn:

string

param OpenIDConnectProviderArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

rtype:

dict

returns:

Response Syntax

{
    'Url': 'string',
    'ClientIDList': [
        'string',
    ],
    'ThumbprintList': [
        'string',
    ],
    'CreateDate': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'ContextProvider': {
        'KeyDefinitionList': [
            {
                'SourceKey': 'string',
                'TargetKey': 'string'
            },
        ],
        'SubjectSourceKey': 'string',
        'SubjectTypeValue': 'string',
        'SubjectTypeSourceKey': 'string'
    },
    'IdentityCenterInstanceArn': 'string',
    'IdentityStoreArn': 'string'
}

Response Structure

  • (dict) --

    Contains the response to a successful GetOpenIDConnectProvider request.

    • Url (string) --

      The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

    • ClientIDList (list) --

      A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

      • (string) --

    • ThumbprintList (list) --

      A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

      • (string) --

        Contains a thumbprint for an identity provider's server certificate.

        The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is used by the domain where the OpenID Connect provider makes its keys available. The thumbprint is always a 40-character string.

    • CreateDate (datetime) --

      The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account.

    • Tags (list) --

      A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      • (dict) --

        A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Key (string) --

          The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

        • Value (string) --

          The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

    • ContextProvider (dict) --

      The trusted identity propagation context provider configuration associated with the IAM OIDC provider resource object. For more information, see ContextProvider.

      This element is returned only when a trusted identity propagation context provider is configured for the OIDC provider.

      • KeyDefinitionList (list) --

        A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

        • (dict) --

          Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

          This data type is used as a member of the ContextProvider data type.

          • SourceKey (string) --

            The key in the external identity provider's assertion or token to read the value from.

            The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

          • TargetKey (string) --

            The trusted context key to map the source value into.

            The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • SubjectSourceKey (string) --

        The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • SubjectTypeValue (string) --

        A static value for the subject type, such as user or workload.

        This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

      • SubjectTypeSourceKey (string) --

        The source key that supplies the subject type from the external identity provider's assertion or token.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

        This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

    • IdentityCenterInstanceArn (string) --

      The Amazon Resource Name (ARN) of the IAM Identity Center instance associated with the IAM OIDC provider resource object.

      For the format, see InstanceMetadata in the IAM Identity Center API Reference.

      This element is returned only when an IAM Identity Center instance is associated with the OIDC provider.

    • IdentityStoreArn (string) --

      The Amazon Resource Name (ARN) of the identity store that is resolved from the associated IAM Identity Center instance.

      For the format, see InstanceMetadata in the IAM Identity Center API Reference.

      This element is returned only when an IAM Identity Center instance is associated with the OIDC provider.

GetSAMLProvider (updated) Link ¶
Changes (response)
{'ContextProvider': {'KeyDefinitionList': [{'SourceKey': 'string',
                                            'TargetKey': 'string'}],
                     'SubjectSourceKey': 'string',
                     'SubjectTypeSourceKey': 'string',
                     'SubjectTypeValue': 'string'},
 'IdentityCenterInstanceArn': 'string',
 'IdentityStoreArn': 'string',
 'SAMLKeyHashes': [{'IssuerURL': 'string', 'KeyHashes': ['string']}]}

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

See also: AWS API Documentation

Request Syntax

client.get_saml_provider(
    SAMLProviderArn='string'
)
type SAMLProviderArn:

string

param SAMLProviderArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

rtype:

dict

returns:

Response Syntax

{
    'SAMLProviderUUID': 'string',
    'SAMLMetadataDocument': 'string',
    'ContextProvider': {
        'KeyDefinitionList': [
            {
                'SourceKey': 'string',
                'TargetKey': 'string'
            },
        ],
        'SubjectSourceKey': 'string',
        'SubjectTypeValue': 'string',
        'SubjectTypeSourceKey': 'string'
    },
    'SAMLKeyHashes': [
        {
            'IssuerURL': 'string',
            'KeyHashes': [
                'string',
            ]
        },
    ],
    'CreateDate': datetime(2015, 1, 1),
    'ValidUntil': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'AssertionEncryptionMode': 'Required'|'Allowed',
    'PrivateKeyList': [
        {
            'KeyId': 'string',
            'Timestamp': datetime(2015, 1, 1)
        },
    ],
    'IdentityCenterInstanceArn': 'string',
    'IdentityStoreArn': 'string'
}

Response Structure

  • (dict) --

    Contains the response to a successful GetSAMLProvider request.

    • SAMLProviderUUID (string) --

      The unique identifier assigned to the SAML provider.

    • SAMLMetadataDocument (string) --

      The XML metadata document that includes information about an identity provider.

    • ContextProvider (dict) --

      The trusted identity propagation context provider configuration associated with the SAML provider. For more information, see ContextProvider.

      This element is returned only when a trusted identity propagation context provider is configured for the SAML provider.

      • KeyDefinitionList (list) --

        A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

        • (dict) --

          Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

          This data type is used as a member of the ContextProvider data type.

          • SourceKey (string) --

            The key in the external identity provider's assertion or token to read the value from.

            The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

          • TargetKey (string) --

            The trusted context key to map the source value into.

            The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • SubjectSourceKey (string) --

        The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • SubjectTypeValue (string) --

        A static value for the subject type, such as user or workload.

        This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

      • SubjectTypeSourceKey (string) --

        The source key that supplies the subject type from the external identity provider's assertion or token.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

        This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

    • SAMLKeyHashes (list) --

      The key hashes associated with the SAML provider, grouped by identity provider issuer. For more information, see SAMLKeyHashEntry.

      • (dict) --

        Contains the key hashes that are associated with a SAML identity provider issuer.

        This data type is used as a response element in the GetSAMLProvider operation.

        • IssuerURL (string) --

          The issuer URL of the SAML identity provider that the key hashes are associated with.

        • KeyHashes (list) --

          The list of key hashes for the SAML identity provider issuer.

          • (string) --

    • CreateDate (datetime) --

      The date and time when the SAML provider was created.

    • ValidUntil (datetime) --

      The expiration date and time for the SAML provider.

    • Tags (list) --

      A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      • (dict) --

        A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        • Key (string) --

          The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

        • Value (string) --

          The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

    • AssertionEncryptionMode (string) --

      Specifies the encryption setting for the SAML provider.

    • PrivateKeyList (list) --

      The private key metadata for the SAML provider.

      • (dict) --

        Contains the private keys for the SAML provider.

        This data type is used as a response element in the GetSAMLProvider operation.

        • KeyId (string) --

          The unique identifier for the SAML private key.

        • Timestamp (datetime) --

          The date and time, in ISO 8601 date-time format, when the private key was uploaded.

    • IdentityCenterInstanceArn (string) --

      The Amazon Resource Name (ARN) of the IAM Identity Center instance associated with the SAML provider.

      For the format, see InstanceMetadata in the IAM Identity Center API Reference.

      This element is returned only when an IAM Identity Center instance is associated with the SAML provider.

    • IdentityStoreArn (string) --

      The Amazon Resource Name (ARN) of the identity store that is resolved from the associated IAM Identity Center instance.

      For the format, see InstanceMetadata in the IAM Identity Center API Reference.

      This element is returned only when an IAM Identity Center instance is associated with the SAML provider.

ListOpenIDConnectProviders (updated) Link ¶
Changes (response)
{'OpenIDConnectProviderList': {'IsTrustedIdentityPropagationEnabled': 'boolean'}}

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_open_id_connect_providers()
rtype:

dict

returns:

Response Syntax

{
    'OpenIDConnectProviderList': [
        {
            'Arn': 'string',
            'IsTrustedIdentityPropagationEnabled': True|False
        },
    ]
}

Response Structure

  • (dict) --

    Contains the response to a successful ListOpenIDConnectProviders request.

    • OpenIDConnectProviderList (list) --

      The list of IAM OIDC provider resource objects defined in the Amazon Web Services account.

      • (dict) --

        Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

        • Arn (string) --

          The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

          For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • IsTrustedIdentityPropagationEnabled (boolean) --

          Specifies whether trusted identity propagation is enabled for the OpenID Connect (OIDC) provider. This is true when an IAM Identity Center instance is associated with the provider.

ListSAMLProviders (updated) Link ¶
Changes (response)
{'SAMLProviderList': {'IsTrustedIdentityPropagationEnabled': 'boolean'}}

Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

See also: AWS API Documentation

Request Syntax

client.list_saml_providers()
rtype:

dict

returns:

Response Syntax

{
    'SAMLProviderList': [
        {
            'Arn': 'string',
            'ValidUntil': datetime(2015, 1, 1),
            'CreateDate': datetime(2015, 1, 1),
            'IsTrustedIdentityPropagationEnabled': True|False
        },
    ]
}

Response Structure

  • (dict) --

    Contains the response to a successful ListSAMLProviders request.

    • SAMLProviderList (list) --

      The list of SAML provider resource objects defined in IAM for this Amazon Web Services account.

      • (dict) --

        Contains the list of SAML providers for this account.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the SAML provider.

        • ValidUntil (datetime) --

          The expiration date and time for the SAML provider.

        • CreateDate (datetime) --

          The date and time when the SAML provider was created.

        • IsTrustedIdentityPropagationEnabled (boolean) --

          Specifies whether trusted identity propagation is enabled for the SAML provider. This is true when an IAM Identity Center instance is associated with the provider.

UpdateSAMLProvider (updated) Link ¶
Changes (request)
{'ContextProvider': {'KeyDefinitionList': [{'SourceKey': 'string',
                                            'TargetKey': 'string'}],
                     'SubjectSourceKey': 'string',
                     'SubjectTypeSourceKey': 'string',
                     'SubjectTypeValue': 'string'},
 'IdentityCenterInstanceArn': 'string',
 'RemoveContextProvider': 'boolean',
 'RemoveIdentityCenterInstance': 'boolean'}

Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.

You can also use this operation to set, change, or remove the trusted identity propagation context provider, and to associate or disassociate an IAM Identity Center instance with the provider. To remove a configuration rather than replace it, use the RemoveContextProvider and RemoveIdentityCenterInstance parameters. For each configuration, provide either the new value or the corresponding Remove flag in a single request, but not both.

A single request can change either the context provider or the provider metadata, but not both. Provider metadata includes the SAML metadata document, assertion encryption mode, private keys, and IAM Identity Center association. To change both, make separate UpdateSAMLProvider requests. To remove the context provider, first remove the IAM Identity Center association in a separate request.

To control who can configure trusted identity propagation on a SAML provider, use the iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:RequestIdentityProviderIssuers, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM policies. The Request keys contain the values in the request. The Resource keys contain the values stored on the provider.

See also: AWS API Documentation

Request Syntax

client.update_saml_provider(
    SAMLMetadataDocument='string',
    SAMLProviderArn='string',
    AssertionEncryptionMode='Required'|'Allowed',
    AddPrivateKey='string',
    RemovePrivateKey='string',
    ContextProvider={
        'KeyDefinitionList': [
            {
                'SourceKey': 'string',
                'TargetKey': 'string'
            },
        ],
        'SubjectSourceKey': 'string',
        'SubjectTypeValue': 'string',
        'SubjectTypeSourceKey': 'string'
    },
    IdentityCenterInstanceArn='string',
    RemoveContextProvider=True|False,
    RemoveIdentityCenterInstance=True|False
)
type SAMLMetadataDocument:

string

param SAMLMetadataDocument:

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

type SAMLProviderArn:

string

param SAMLProviderArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

type AssertionEncryptionMode:

string

param AssertionEncryptionMode:

Specifies the encryption setting for the SAML provider.

type AddPrivateKey:

string

param AddPrivateKey:

Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

type RemovePrivateKey:

string

param RemovePrivateKey:

The Key ID of the private key to remove.

type ContextProvider:

dict

param ContextProvider:

The trusted identity propagation context provider configuration to associate with the SAML provider. This replaces the existing context provider configuration. For more information, see ContextProvider.

  • KeyDefinitionList (list) --

    A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

    • (dict) --

      Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

      This data type is used as a member of the ContextProvider data type.

      • SourceKey (string) -- [REQUIRED]

        The key in the external identity provider's assertion or token to read the value from.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      • TargetKey (string) --

        The trusted context key to map the source value into.

        The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectSourceKey (string) -- [REQUIRED]

    The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

  • SubjectTypeValue (string) --

    A static value for the subject type, such as user or workload.

    This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

  • SubjectTypeSourceKey (string) --

    The source key that supplies the subject type from the external identity provider's assertion or token.

    The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

    This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

type IdentityCenterInstanceArn:

string

param IdentityCenterInstanceArn:

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the SAML provider.

For the format, see InstanceMetadata in the IAM Identity Center API Reference.

type RemoveContextProvider:

boolean

param RemoveContextProvider:

Specifies whether to remove the existing trusted identity propagation context provider configuration from the SAML provider. When set to true, the context provider is removed. This parameter is mutually exclusive with ContextProvider.

type RemoveIdentityCenterInstance:

boolean

param RemoveIdentityCenterInstance:

Specifies whether to disassociate the IAM Identity Center instance from the SAML provider. When set to true, the instance is disassociated. This parameter is mutually exclusive with IdentityCenterInstanceArn.

rtype:

dict

returns:

Response Syntax

{
    'SAMLProviderArn': 'string'
}

Response Structure

  • (dict) --

    Contains the response to a successful UpdateSAMLProvider request.

    • SAMLProviderArn (string) --

      The Amazon Resource Name (ARN) of the SAML provider that was updated.