Configuration for JWT authenticator in the managed cluster.
Uses Azure REST API version 2025-07-02-preview.
Other available API versions: 2025-08-02-preview, 2025-09-02-preview, 2025-10-02-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native containerservice [ApiVersion]. See the version guide for details.
Using getJWTAuthenticator
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getJWTAuthenticator(args: GetJWTAuthenticatorArgs, opts?: InvokeOptions): Promise<GetJWTAuthenticatorResult>
function getJWTAuthenticatorOutput(args: GetJWTAuthenticatorOutputArgs, opts?: InvokeOptions): Output<GetJWTAuthenticatorResult>def get_jwt_authenticator(jwt_authenticator_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
resource_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetJWTAuthenticatorResult
def get_jwt_authenticator_output(jwt_authenticator_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
resource_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetJWTAuthenticatorResult]func LookupJWTAuthenticator(ctx *Context, args *LookupJWTAuthenticatorArgs, opts ...InvokeOption) (*LookupJWTAuthenticatorResult, error)
func LookupJWTAuthenticatorOutput(ctx *Context, args *LookupJWTAuthenticatorOutputArgs, opts ...InvokeOption) LookupJWTAuthenticatorResultOutput> Note: This function is named LookupJWTAuthenticator in the Go SDK.
public static class GetJWTAuthenticator
{
public static Task<GetJWTAuthenticatorResult> InvokeAsync(GetJWTAuthenticatorArgs args, InvokeOptions? opts = null)
public static Output<GetJWTAuthenticatorResult> Invoke(GetJWTAuthenticatorInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetJWTAuthenticatorResult> getJWTAuthenticator(GetJWTAuthenticatorArgs args, InvokeOptions options)
public static Output<GetJWTAuthenticatorResult> getJWTAuthenticator(GetJWTAuthenticatorArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:containerservice:getJWTAuthenticator
arguments:
# arguments dictionaryThe following arguments are supported:
- Jwt
Authenticator stringName - The name of the JWT authenticator.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Resource
Name string - The name of the managed cluster resource.
- Jwt
Authenticator stringName - The name of the JWT authenticator.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Resource
Name string - The name of the managed cluster resource.
- jwt
Authenticator StringName - The name of the JWT authenticator.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- resource
Name String - The name of the managed cluster resource.
- jwt
Authenticator stringName - The name of the JWT authenticator.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- resource
Name string - The name of the managed cluster resource.
- jwt_
authenticator_ strname - The name of the JWT authenticator.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- resource_
name str - The name of the managed cluster resource.
- jwt
Authenticator StringName - The name of the JWT authenticator.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- resource
Name String - The name of the managed cluster resource.
getJWTAuthenticator Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Properties
Pulumi.
Azure Native. Container Service. Outputs. JWTAuthenticator Properties Response - 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.
- System
Data Pulumi.Azure Native. Container Service. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Properties
JWTAuthenticator
Properties Response - 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.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- properties
JWTAuthenticator
Properties Response - 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.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name string
- The name of the resource
- properties
JWTAuthenticator
Properties Response - 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.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name str
- The name of the resource
- properties
JWTAuthenticator
Properties Response - 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.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- properties Property Map
- 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.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
JWTAuthenticatorClaimMappingExpressionResponse
- Expression string
- The CEL expression used to access token claims.
- Expression string
- The CEL expression used to access token claims.
- expression String
- The CEL expression used to access token claims.
- expression string
- The CEL expression used to access token claims.
- expression str
- The CEL expression used to access token claims.
- expression String
- The CEL expression used to access token claims.
JWTAuthenticatorClaimMappingsResponse
- Username
Pulumi.
Azure Native. Container Service. Inputs. JWTAuthenticator Claim Mapping Expression Response - The expression to extract username attribute from the token claims.
- Extra
List<Pulumi.
Azure Native. Container Service. Inputs. JWTAuthenticator Extra Claim Mapping Expression Response> - The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims.
- Groups
Pulumi.
Azure Native. Container Service. Inputs. JWTAuthenticator Claim Mapping Expression Response - The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims.
- Uid
Pulumi.
Azure Native. Container Service. Inputs. JWTAuthenticator Claim Mapping Expression Response - The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims.
- Username
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract username attribute from the token claims.
- Extra
[]JWTAuthenticator
Extra Claim Mapping Expression Response - The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims.
- Groups
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims.
- Uid
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims.
- username
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract username attribute from the token claims.
- extra
List<JWTAuthenticator
Extra Claim Mapping Expression Response> - The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims.
- groups
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims.
- uid
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims.
- username
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract username attribute from the token claims.
- extra
JWTAuthenticator
Extra Claim Mapping Expression Response[] - The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims.
- groups
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims.
- uid
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims.
- username
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract username attribute from the token claims.
- extra
Sequence[JWTAuthenticator
Extra Claim Mapping Expression Response] - The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims.
- groups
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims.
- uid
JWTAuthenticator
Claim Mapping Expression Response - The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims.
- username Property Map
- The expression to extract username attribute from the token claims.
- extra List<Property Map>
- The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims.
- groups Property Map
- The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims.
- uid Property Map
- The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims.
JWTAuthenticatorExtraClaimMappingExpressionResponse
- Key string
- The key of the extra attribute.
- Value
Expression string - The CEL expression used to extract the value of the extra attribute.
- Key string
- The key of the extra attribute.
- Value
Expression string - The CEL expression used to extract the value of the extra attribute.
- key String
- The key of the extra attribute.
- value
Expression String - The CEL expression used to extract the value of the extra attribute.
- key string
- The key of the extra attribute.
- value
Expression string - The CEL expression used to extract the value of the extra attribute.
- key str
- The key of the extra attribute.
- value_
expression str - The CEL expression used to extract the value of the extra attribute.
- key String
- The key of the extra attribute.
- value
Expression String - The CEL expression used to extract the value of the extra attribute.
JWTAuthenticatorIssuerResponse
- Audiences List<string>
- The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration.
- Url string
- The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
- Audiences []string
- The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration.
- Url string
- The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
- audiences List<String>
- The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration.
- url String
- The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
- audiences string[]
- The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration.
- url string
- The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
- audiences Sequence[str]
- The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration.
- url str
- The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
- audiences List<String>
- The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration.
- url String
- The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery.
JWTAuthenticatorPropertiesResponse
- Claim
Mappings Pulumi.Azure Native. Container Service. Inputs. JWTAuthenticator Claim Mappings Response - The mappings that define how user attributes are extracted from the token claims.
- Issuer
Pulumi.
Azure Native. Container Service. Inputs. JWTAuthenticator Issuer Response - The JWT OIDC issuer details.
- Provisioning
State string - The current provisioning state of the JWT authenticator.
- Claim
Validation List<Pulumi.Rules Azure Native. Container Service. Inputs. JWTAuthenticator Validation Rule Response> - The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
- User
Validation List<Pulumi.Rules Azure Native. Container Service. Inputs. JWTAuthenticator Validation Rule Response> - The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.
- Claim
Mappings JWTAuthenticatorClaim Mappings Response - The mappings that define how user attributes are extracted from the token claims.
- Issuer
JWTAuthenticator
Issuer Response - The JWT OIDC issuer details.
- Provisioning
State string - The current provisioning state of the JWT authenticator.
- Claim
Validation []JWTAuthenticatorRules Validation Rule Response - The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
- User
Validation []JWTAuthenticatorRules Validation Rule Response - The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.
- claim
Mappings JWTAuthenticatorClaim Mappings Response - The mappings that define how user attributes are extracted from the token claims.
- issuer
JWTAuthenticator
Issuer Response - The JWT OIDC issuer details.
- provisioning
State String - The current provisioning state of the JWT authenticator.
- claim
Validation List<JWTAuthenticatorRules Validation Rule Response> - The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
- user
Validation List<JWTAuthenticatorRules Validation Rule Response> - The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.
- claim
Mappings JWTAuthenticatorClaim Mappings Response - The mappings that define how user attributes are extracted from the token claims.
- issuer
JWTAuthenticator
Issuer Response - The JWT OIDC issuer details.
- provisioning
State string - The current provisioning state of the JWT authenticator.
- claim
Validation JWTAuthenticatorRules Validation Rule Response[] - The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
- user
Validation JWTAuthenticatorRules Validation Rule Response[] - The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.
- claim_
mappings JWTAuthenticatorClaim Mappings Response - The mappings that define how user attributes are extracted from the token claims.
- issuer
JWTAuthenticator
Issuer Response - The JWT OIDC issuer details.
- provisioning_
state str - The current provisioning state of the JWT authenticator.
- claim_
validation_ Sequence[JWTAuthenticatorrules Validation Rule Response] - The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
- user_
validation_ Sequence[JWTAuthenticatorrules Validation Rule Response] - The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.
- claim
Mappings Property Map - The mappings that define how user attributes are extracted from the token claims.
- issuer Property Map
- The JWT OIDC issuer details.
- provisioning
State String - The current provisioning state of the JWT authenticator.
- claim
Validation List<Property Map>Rules - The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
- user
Validation List<Property Map>Rules - The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.
JWTAuthenticatorValidationRuleResponse
- Expression string
- The CEL expression used to validate the claim or attribute.
- Message string
- The validation error message.
- Expression string
- The CEL expression used to validate the claim or attribute.
- Message string
- The validation error message.
- expression String
- The CEL expression used to validate the claim or attribute.
- message String
- The validation error message.
- expression string
- The CEL expression used to validate the claim or attribute.
- message string
- The validation error message.
- expression str
- The CEL expression used to validate the claim or attribute.
- message str
- The validation error message.
- expression String
- The CEL expression used to validate the claim or attribute.
- message String
- The validation error message.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
