Skip to content

IAM  >  Operations  >  enable_outbound_web_identity_federation

enable_outbound_web_identity_federation

Operation

enable_outbound_web_identity_federation async

enable_outbound_web_identity_federation(request: EnableOutboundWebIdentityFederationInput | EnableOutboundWebIdentityFederationInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableOutboundWebIdentityFederationOutput
enable_outbound_web_identity_federation(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableOutboundWebIdentityFederationInputDict]) -> EnableOutboundWebIdentityFederationOutput

Enables the outbound identity federation feature for your Amazon Web Services account. When enabled, IAM principals in your account can use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for secure authentication with external services. This operation also generates a unique issuer URL for your Amazon Web Services account.

Parameters:

Name Type Description Default
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

Returns:

Type Description
EnableOutboundWebIdentityFederationOutput

An instance of EnableOutboundWebIdentityFederationOutput.

Input

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

Model

EnableOutboundWebIdentityFederationInput dataclass

Bases: _SerdeShape

Dataclass for EnableOutboundWebIdentityFederationInput structure.

Dictionaries

EnableOutboundWebIdentityFederationInputDict

Bases: TypedDict

Dictionary form of EnableOutboundWebIdentityFederationInput.

Output

EnableOutboundWebIdentityFederationOutput dataclass

Bases: _SerdeShape

Dataclass for EnableOutboundWebIdentityFederationOutput structure.

Attributes

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

A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints at /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary for token verification.

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.