Skip to content

CustomOauth2ProviderConfigInputDict

Dictionary Type

CustomOauth2ProviderConfigInputDict

Bases: TypedDict

Dictionary form of CustomOauth2ProviderConfigInput.

Attributes

certificate_configurations instance-attribute
certificate_configurations: Sequence[CertificateConfiguration | CertificateConfigurationDict] | 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 instance-attribute
client_authentication_method: str | None

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

client_id instance-attribute
client_id: str | None

The client ID for the custom OAuth2 provider.

client_secret instance-attribute
client_secret: str | None

The client secret for the custom OAuth2 provider.

client_secret_config instance-attribute
client_secret_config: SecretReference | SecretReferenceDict | 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 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

The OAuth2 discovery information for the custom provider.

on_behalf_of_token_exchange_config instance-attribute
on_behalf_of_token_exchange_config: OnBehalfOfTokenExchangeConfigType | OnBehalfOfTokenExchangeConfigTypeDict | 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 instance-attribute
private_endpoint: PrivateEndpoint | PrivateEndpointDict | None

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

private_endpoint_overrides instance-attribute
private_endpoint_overrides: Sequence[PrivateEndpointOverride | PrivateEndpointOverrideDict] | None

The private endpoint overrides for the custom OAuth2 provider configuration.

private_key_jwt_config instance-attribute
private_key_jwt_config: PrivateKeyJwtConfig | PrivateKeyJwtConfigDict | 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.