JWTAuthenticatorProperties interface

Package:

@azure/arm-containerservice

The properties of JWTAuthenticator. For details on how to configure the properties of a JWT authenticator, please refer to the Kubernetes documentation: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration. Please note that not all fields available in the Kubernetes documentation are supported by AKS. For troubleshooting, please see https://aka.ms/aks-external-issuers-docs.

Properties

certificateAuthorityBundle	PEM-encoded CA certificate bundle used to validate the connection when fetching discovery information. Use this for issuer endpoints that use private certificate authorities or environments where TLS inspection is performed. The bundle must contain only CERTIFICATE PEM blocks, up to 10 CA certificates, and must be no larger than 20 KB in total. Include all CA certificates needed to validate the issuer endpoint's TLS certificate. Certificate revocation checking is not supported. If provided, only these CAs are trusted instead of the well-known root CAs. If not provided and the managed cluster's properties.securityProfile.customCATrustCertificates is set, those certificates will be used instead. Otherwise, only the well-known root CAs are trusted.
claimMappings	The mappings that define how user attributes are extracted from the token claims.
claimValidationRules	The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
issuer	The JWT OIDC issuer details.
provisioningState	The current provisioning state of the JWT authenticator.
userValidationRules	The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.

Property Details

certificateAuthorityBundle

PEM-encoded CA certificate bundle used to validate the connection when fetching discovery information. Use this for issuer endpoints that use private certificate authorities or environments where TLS inspection is performed.

The bundle must contain only CERTIFICATE PEM blocks, up to 10 CA certificates, and must be no larger than 20 KB in total. Include all CA certificates needed to validate the issuer endpoint's TLS certificate. Certificate revocation checking is not supported.

If provided, only these CAs are trusted instead of the well-known root CAs. If not provided and the managed cluster's properties.securityProfile.customCATrustCertificates is set, those certificates will be used instead. Otherwise, only the well-known root CAs are trusted.

certificateAuthorityBundle?: string

Property Value

string

claimMappings

The mappings that define how user attributes are extracted from the token claims.

claimMappings: JWTAuthenticatorClaimMappings

Property Value

JWTAuthenticatorClaimMappings

claimValidationRules

The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.

claimValidationRules?: JWTAuthenticatorValidationRule[]

Property Value

JWTAuthenticatorValidationRule[]

issuer

The JWT OIDC issuer details.

issuer: JWTAuthenticatorIssuer

Property Value

JWTAuthenticatorIssuer

provisioningState

The current provisioning state of the JWT authenticator.

provisioningState?: string

Property Value

string

userValidationRules

The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.

userValidationRules?: JWTAuthenticatorValidationRule[]

Property Value

JWTAuthenticatorValidationRule[]