CustomJWTAuthorizerConfiguration¶
Structure Class¶
CustomJWTAuthorizerConfiguration
dataclass
¶
Bases: _SerdeShape
Configuration for inbound JWT-based authorization, specifying how incoming requests should be authenticated.
Attributes¶
advertised_scope_mapping
class-attribute
instance-attribute
¶
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
class-attribute
instance-attribute
¶
Represents individual audience values that are validated in the incoming JWT token validation process.
allowed_clients
class-attribute
instance-attribute
¶
Represents individual client IDs that are validated in the incoming JWT token validation process.
allowed_scopes
class-attribute
instance-attribute
¶
An array of scopes that are allowed to access the token.
allowed_workload_configuration
class-attribute
instance-attribute
¶
allowed_workload_configuration: AllowedWorkloadConfiguration | 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
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.
custom_claims
class-attribute
instance-attribute
¶
custom_claims: list[CustomClaimValidationType] | None = ...
An array of objects that define a custom claim validation name, value, and operation
discovery_url
instance-attribute
¶
discovery_url: str
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
private_endpoint
class-attribute
instance-attribute
¶
private_endpoint: PrivateEndpoint | None = ...
The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.
private_endpoint_overrides
class-attribute
instance-attribute
¶
private_endpoint_overrides: list[PrivateEndpointOverride] | None = ...
The private endpoint overrides for the custom JWT authorizer configuration.