Skip to content

CustomJWTAuthorizerConfigurationDict

Dictionary Type

CustomJWTAuthorizerConfigurationDict

Bases: TypedDict

Dictionary form of CustomJWTAuthorizerConfiguration.

Attributes

advertised_scope_mapping instance-attribute
advertised_scope_mapping: Mapping[str, str] | None

A map that associates each scope in allowedScopes with a corresponding advertised scope value. The advertised scope appears in OAuth protected resource metadata and WWW-Authenticate response headers. Use this parameter when the scope that clients request from your identity provider differs from the scope in the validated token. Each key is a scope from allowedScopes that the service uses for token validation. Each value is the corresponding scope that the service advertises to clients. Scopes without a mapping entry appear unchanged to clients.

allowed_audience instance-attribute
allowed_audience: Sequence[str] | None

Represents individual audience values that are validated in the incoming JWT token validation process.

allowed_clients instance-attribute
allowed_clients: Sequence[str] | None

Represents individual client IDs that are validated in the incoming JWT token validation process.

allowed_scopes instance-attribute
allowed_scopes: Sequence[str] | None

An array of scopes that are allowed to access the token.

allowed_workload_configuration instance-attribute
allowed_workload_configuration: AllowedWorkloadConfiguration | AllowedWorkloadConfigurationDict | None

The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.

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.

custom_claims instance-attribute

An array of objects that define a custom claim validation name, value, and operation

discovery_url instance-attribute
discovery_url: Required[str]

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

private_endpoint instance-attribute
private_endpoint: PrivateEndpoint | PrivateEndpointDict | None

The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

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

The private endpoint overrides for the custom JWT authorizer configuration.