Skip to content

CustomOauth2ProviderConfigInput

Structure Class

CustomOauth2ProviderConfigInput dataclass

Bases: _SerdeShape

Input configuration for a custom OAuth2 provider.

Attributes

certificate_configurations class-attribute instance-attribute
certificate_configurations: list[CertificateConfiguration] | None = ...

The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Web Services Secrets Manager secret. You can use this only together with privateEndpoint.

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

The client authentication method to use when authenticating with the token endpoint.

client_id class-attribute instance-attribute
client_id: str = ...

The client ID for the custom OAuth2 provider.

client_secret class-attribute instance-attribute
client_secret: str = ...

The client secret for the custom OAuth2 provider.

client_secret_config class-attribute instance-attribute
client_secret_config: SecretReference | None = ...

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

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

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

oauth_discovery instance-attribute
oauth_discovery: Oauth2Discovery

The OAuth2 discovery information for the custom provider.

on_behalf_of_token_exchange_config class-attribute instance-attribute
on_behalf_of_token_exchange_config: OnBehalfOfTokenExchangeConfigType | None = ...

The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.

private_endpoint class-attribute instance-attribute
private_endpoint: PrivateEndpoint | None = ...

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

private_endpoint_overrides class-attribute instance-attribute
private_endpoint_overrides: list[PrivateEndpointOverride] | None = ...

The private endpoint overrides for the custom OAuth2 provider configuration.

private_key_jwt_config class-attribute instance-attribute
private_key_jwt_config: PrivateKeyJwtConfig | None = ...

The private_key_jwt client authentication configuration for this credential provider. When specified, the credential provider uses JWT client assertions to authenticate with the token endpoint.