Skip to content

update_open_id_connect_provider_thumbprint

Operation

update_open_id_connect_provider_thumbprint

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

Note

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.

Note: Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.

Parameters:

Name Type Description Default
request UpdateOpenIDConnectProviderThumbprintInput | UpdateOpenIDConnectProviderThumbprintInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[UpdateOpenIDConnectProviderThumbprintInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateOpenIDConnectProviderThumbprintOutput

An instance of UpdateOpenIDConnectProviderThumbprintOutput.

update_open_id_connect_provider_thumbprint async

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

Note

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.

Note: Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.

Parameters:

Name Type Description Default
request UpdateOpenIDConnectProviderThumbprintInput | UpdateOpenIDConnectProviderThumbprintInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[UpdateOpenIDConnectProviderThumbprintInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateOpenIDConnectProviderThumbprintOutput

An instance of UpdateOpenIDConnectProviderThumbprintOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateOpenIDConnectProviderThumbprintInputDict

Bases: TypedDict

Dictionary form of UpdateOpenIDConnectProviderThumbprintInput.

Attributes

open_id_connect_provider_arn instance-attribute
open_id_connect_provider_arn: Required[str]

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

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

thumbprint_list instance-attribute
thumbprint_list: Required[Sequence[str]]

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

UpdateOpenIDConnectProviderThumbprintInput dataclass

Bases: _SerdeShape

Dataclass for UpdateOpenIDConnectProviderThumbprintInput structure.

Attributes

open_id_connect_provider_arn class-attribute instance-attribute
open_id_connect_provider_arn: str | None = ...

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

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

thumbprint_list class-attribute instance-attribute
thumbprint_list: list[str] | None = ...

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

Output

UpdateOpenIDConnectProviderThumbprintOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateOpenIDConnectProviderThumbprintOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.