Share via


JWTAuthenticatorProperties interface

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

claimMappings

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

claimMappings: JWTAuthenticatorClaimMappings

Property Value

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

issuer

The JWT OIDC issuer details.

issuer: JWTAuthenticatorIssuer

Property Value

provisioningState

The current provisioning state of the JWT authenticator. NOTE: This property will not be serialized. It can only be populated by the server.

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