Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The hcpOpenShiftClusters/externalAuths resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths@2026-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
claim: {
mappings: {
groups: {
claim: 'string'
prefix: 'string'
}
username: {
claim: 'string'
prefix: 'string'
prefixPolicy: 'string'
}
}
validationRules: [
{
requiredClaim: {
claim: 'string'
requiredValue: 'string'
}
type: 'string'
}
]
}
clients: [
{
clientId: 'string'
component: {
authClientNamespace: 'string'
name: 'string'
}
extraScopes: [
'string'
]
type: 'string'
}
]
issuer: {
audiences: [
'string'
]
ca: 'string'
url: 'string'
}
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z]([-a-zA-Z0-9]{0,13}[a-zA-Z0-9])?$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: hcpOpenShiftClusters |
| properties | The resource-specific properties for this resource. | ExternalAuthProperties |
ExternalAuthClaimProfile
| Name | Description | Value |
|---|---|---|
| mappings | The claim mappings | TokenClaimMappingsProfile (required) |
| validationRules | The claim validation rules | TokenClaimValidationRule[] |
ExternalAuthClientComponentProfile
| Name | Description | Value |
|---|---|---|
| authClientNamespace | The namespace of the external Auth client This specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with name as a unique identifier. |
string Constraints: Min length = 1 Max length = 63 (required) |
| name | The name of the external auth client This specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with namespace as a unique identifier. |
string Constraints: Min length = 1 Max length = 256 (required) |
ExternalAuthClientProfile
| Name | Description | Value |
|---|---|---|
| clientId | External Auth client id The clientId must appear in the audience field of the TokenIssuerProfile. |
string Constraints: Min length = 1 (required) |
| component | External Auth client component | ExternalAuthClientComponentProfile (required) |
| extraScopes | external auth client scopes This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes. When omitted, no additional scopes are requested. |
string[] |
| type | Determines the OIDC provider client type. | 'Confidential' 'Public' (required) |
ExternalAuthProperties
| Name | Description | Value |
|---|---|---|
| claim | External Auth claim This configures how claims are validated and applied. |
ExternalAuthClaimProfile (required) |
| clients | External Auth OIDC clients There must not be more than 20 entries and entries must have unique namespace/name pairs. |
ExternalAuthClientProfile[] |
| issuer | Token Issuer profile | TokenIssuerProfile (required) |
GroupClaimProfile
| Name | Description | Value |
|---|---|---|
| claim | Claim name of the external profile | string Constraints: Min length = 1 Max length = 256 (required) |
| prefix | Prefix for the claim external profile If this is specified prefixPolicy will be set to "Prefix" by default |
string |
TokenClaimMappingsProfile
| Name | Description | Value |
|---|---|---|
| groups | The claim mappings groups. | GroupClaimProfile |
| username | The claim mappings username. | UsernameClaimProfile (required) |
TokenClaimValidationRule
| Name | Description | Value |
|---|---|---|
| requiredClaim | The required claim rule to be applied. | TokenRequiredClaim |
| type | This configures the type of the validation rule. It defaults to "RequiredClaim" |
'RequiredClaim' |
TokenIssuerProfile
| Name | Description | Value |
|---|---|---|
| audiences | This configures the acceptable audiences the JWT token, issued by the identity provider, must be issued to. At least one of the entries must match the 'aud' claim in the JWT token. audiences must contain at least one entry and must not exceed ten entries. |
string[] (required) |
| ca | The issuer of the token Certificate bundle to use to validate server certificates for the configured URL. It must be PEM encoded and when not specified, the system trust is used. |
string |
| url | This configures the URL used to issue tokens by the identity provider. The Kubernetes API server determines how authentication tokens should be handled by matching the 'iss' claim in the JWT to the issuerURL of configured identity providers. issuerURL must use the 'https' scheme. |
string (required) |
TokenRequiredClaim
| Name | Description | Value |
|---|---|---|
| claim | Claim name for the validation profile claim is a required field that configures the name of the required claim. |
string Constraints: Min length = 1 (required) |
| requiredValue | Required value requiredValue is a required field that configures the value that 'claim' must have when taken from the incoming JWT claims. If the value in the JWT claims does not match, the token will be rejected for authentication. |
string Constraints: Min length = 1 (required) |
UsernameClaimProfile
| Name | Description | Value |
|---|---|---|
| claim | Claim name of the external profile | string Constraints: Min length = 1 Max length = 256 (required) |
| prefix | Prefix for the claim external profile Must be set when the prefixPolicy field is set to 'Prefix' and must be unset otherwise. |
string |
| prefixPolicy | Prefix policy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field. Allowed values are 'Prefix', 'NoPrefix', and 'None'. If not specified, the default policy is 'None'. When set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'. When set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim. When set to 'None', this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends {issuerURL}# to the value of the JWT claimwhen the claim is not 'email'. As an example, consider the following scenario: prefix is unset, issuerURL is set to https://myoidc.tld,the JWT claims include "username":"userA" and "email":"userA |
'None' 'NoPrefix' 'Prefix' |
ARM template resource definition
The hcpOpenShiftClusters/externalAuths resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths resource, add the following JSON to your template.
{
"type": "Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths",
"apiVersion": "2026-09-01-preview",
"name": "string",
"properties": {
"claim": {
"mappings": {
"groups": {
"claim": "string",
"prefix": "string"
},
"username": {
"claim": "string",
"prefix": "string",
"prefixPolicy": "string"
}
},
"validationRules": [
{
"requiredClaim": {
"claim": "string",
"requiredValue": "string"
},
"type": "string"
}
]
},
"clients": [
{
"clientId": "string",
"component": {
"authClientNamespace": "string",
"name": "string"
},
"extraScopes": [ "string" ],
"type": "string"
}
],
"issuer": {
"audiences": [ "string" ],
"ca": "string",
"url": "string"
}
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-09-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z]([-a-zA-Z0-9]{0,13}[a-zA-Z0-9])?$ (required) |
| properties | The resource-specific properties for this resource. | ExternalAuthProperties |
| type | The resource type | 'Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths' |
ExternalAuthClaimProfile
| Name | Description | Value |
|---|---|---|
| mappings | The claim mappings | TokenClaimMappingsProfile (required) |
| validationRules | The claim validation rules | TokenClaimValidationRule[] |
ExternalAuthClientComponentProfile
| Name | Description | Value |
|---|---|---|
| authClientNamespace | The namespace of the external Auth client This specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with name as a unique identifier. |
string Constraints: Min length = 1 Max length = 63 (required) |
| name | The name of the external auth client This specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with namespace as a unique identifier. |
string Constraints: Min length = 1 Max length = 256 (required) |
ExternalAuthClientProfile
| Name | Description | Value |
|---|---|---|
| clientId | External Auth client id The clientId must appear in the audience field of the TokenIssuerProfile. |
string Constraints: Min length = 1 (required) |
| component | External Auth client component | ExternalAuthClientComponentProfile (required) |
| extraScopes | external auth client scopes This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes. When omitted, no additional scopes are requested. |
string[] |
| type | Determines the OIDC provider client type. | 'Confidential' 'Public' (required) |
ExternalAuthProperties
| Name | Description | Value |
|---|---|---|
| claim | External Auth claim This configures how claims are validated and applied. |
ExternalAuthClaimProfile (required) |
| clients | External Auth OIDC clients There must not be more than 20 entries and entries must have unique namespace/name pairs. |
ExternalAuthClientProfile[] |
| issuer | Token Issuer profile | TokenIssuerProfile (required) |
GroupClaimProfile
| Name | Description | Value |
|---|---|---|
| claim | Claim name of the external profile | string Constraints: Min length = 1 Max length = 256 (required) |
| prefix | Prefix for the claim external profile If this is specified prefixPolicy will be set to "Prefix" by default |
string |
TokenClaimMappingsProfile
| Name | Description | Value |
|---|---|---|
| groups | The claim mappings groups. | GroupClaimProfile |
| username | The claim mappings username. | UsernameClaimProfile (required) |
TokenClaimValidationRule
| Name | Description | Value |
|---|---|---|
| requiredClaim | The required claim rule to be applied. | TokenRequiredClaim |
| type | This configures the type of the validation rule. It defaults to "RequiredClaim" |
'RequiredClaim' |
TokenIssuerProfile
| Name | Description | Value |
|---|---|---|
| audiences | This configures the acceptable audiences the JWT token, issued by the identity provider, must be issued to. At least one of the entries must match the 'aud' claim in the JWT token. audiences must contain at least one entry and must not exceed ten entries. |
string[] (required) |
| ca | The issuer of the token Certificate bundle to use to validate server certificates for the configured URL. It must be PEM encoded and when not specified, the system trust is used. |
string |
| url | This configures the URL used to issue tokens by the identity provider. The Kubernetes API server determines how authentication tokens should be handled by matching the 'iss' claim in the JWT to the issuerURL of configured identity providers. issuerURL must use the 'https' scheme. |
string (required) |
TokenRequiredClaim
| Name | Description | Value |
|---|---|---|
| claim | Claim name for the validation profile claim is a required field that configures the name of the required claim. |
string Constraints: Min length = 1 (required) |
| requiredValue | Required value requiredValue is a required field that configures the value that 'claim' must have when taken from the incoming JWT claims. If the value in the JWT claims does not match, the token will be rejected for authentication. |
string Constraints: Min length = 1 (required) |
UsernameClaimProfile
| Name | Description | Value |
|---|---|---|
| claim | Claim name of the external profile | string Constraints: Min length = 1 Max length = 256 (required) |
| prefix | Prefix for the claim external profile Must be set when the prefixPolicy field is set to 'Prefix' and must be unset otherwise. |
string |
| prefixPolicy | Prefix policy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field. Allowed values are 'Prefix', 'NoPrefix', and 'None'. If not specified, the default policy is 'None'. When set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'. When set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim. When set to 'None', this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends {issuerURL}# to the value of the JWT claimwhen the claim is not 'email'. As an example, consider the following scenario: prefix is unset, issuerURL is set to https://myoidc.tld,the JWT claims include "username":"userA" and "email":"userA |
'None' 'NoPrefix' 'Prefix' |
Terraform (AzAPI provider) resource definition
The hcpOpenShiftClusters/externalAuths resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths@2026-09-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
claim = {
mappings = {
groups = {
claim = "string"
prefix = "string"
}
username = {
claim = "string"
prefix = "string"
prefixPolicy = "string"
}
}
validationRules = [
{
requiredClaim = {
claim = "string"
requiredValue = "string"
}
type = "string"
}
]
}
clients = [
{
clientId = "string"
component = {
authClientNamespace = "string"
name = "string"
}
extraScopes = [
"string"
]
type = "string"
}
]
issuer = {
audiences = [
"string"
]
ca = "string"
url = "string"
}
}
}
}
Property Values
Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z]([-a-zA-Z0-9]{0,13}[a-zA-Z0-9])?$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hcpOpenShiftClusters |
| properties | The resource-specific properties for this resource. | ExternalAuthProperties |
| type | The resource type | "Microsoft.RedHatOpenShift/hcpOpenShiftClusters/externalAuths@2026-09-01-preview" |
ExternalAuthClaimProfile
| Name | Description | Value |
|---|---|---|
| mappings | The claim mappings | TokenClaimMappingsProfile (required) |
| validationRules | The claim validation rules | TokenClaimValidationRule[] |
ExternalAuthClientComponentProfile
| Name | Description | Value |
|---|---|---|
| authClientNamespace | The namespace of the external Auth client This specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with name as a unique identifier. |
string Constraints: Min length = 1 Max length = 63 (required) |
| name | The name of the external auth client This specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with namespace as a unique identifier. |
string Constraints: Min length = 1 Max length = 256 (required) |
ExternalAuthClientProfile
| Name | Description | Value |
|---|---|---|
| clientId | External Auth client id The clientId must appear in the audience field of the TokenIssuerProfile. |
string Constraints: Min length = 1 (required) |
| component | External Auth client component | ExternalAuthClientComponentProfile (required) |
| extraScopes | external auth client scopes This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes. When omitted, no additional scopes are requested. |
string[] |
| type | Determines the OIDC provider client type. | 'Confidential' 'Public' (required) |
ExternalAuthProperties
| Name | Description | Value |
|---|---|---|
| claim | External Auth claim This configures how claims are validated and applied. |
ExternalAuthClaimProfile (required) |
| clients | External Auth OIDC clients There must not be more than 20 entries and entries must have unique namespace/name pairs. |
ExternalAuthClientProfile[] |
| issuer | Token Issuer profile | TokenIssuerProfile (required) |
GroupClaimProfile
| Name | Description | Value |
|---|---|---|
| claim | Claim name of the external profile | string Constraints: Min length = 1 Max length = 256 (required) |
| prefix | Prefix for the claim external profile If this is specified prefixPolicy will be set to "Prefix" by default |
string |
TokenClaimMappingsProfile
| Name | Description | Value |
|---|---|---|
| groups | The claim mappings groups. | GroupClaimProfile |
| username | The claim mappings username. | UsernameClaimProfile (required) |
TokenClaimValidationRule
| Name | Description | Value |
|---|---|---|
| requiredClaim | The required claim rule to be applied. | TokenRequiredClaim |
| type | This configures the type of the validation rule. It defaults to "RequiredClaim" |
'RequiredClaim' |
TokenIssuerProfile
| Name | Description | Value |
|---|---|---|
| audiences | This configures the acceptable audiences the JWT token, issued by the identity provider, must be issued to. At least one of the entries must match the 'aud' claim in the JWT token. audiences must contain at least one entry and must not exceed ten entries. |
string[] (required) |
| ca | The issuer of the token Certificate bundle to use to validate server certificates for the configured URL. It must be PEM encoded and when not specified, the system trust is used. |
string |
| url | This configures the URL used to issue tokens by the identity provider. The Kubernetes API server determines how authentication tokens should be handled by matching the 'iss' claim in the JWT to the issuerURL of configured identity providers. issuerURL must use the 'https' scheme. |
string (required) |
TokenRequiredClaim
| Name | Description | Value |
|---|---|---|
| claim | Claim name for the validation profile claim is a required field that configures the name of the required claim. |
string Constraints: Min length = 1 (required) |
| requiredValue | Required value requiredValue is a required field that configures the value that 'claim' must have when taken from the incoming JWT claims. If the value in the JWT claims does not match, the token will be rejected for authentication. |
string Constraints: Min length = 1 (required) |
UsernameClaimProfile
| Name | Description | Value |
|---|---|---|
| claim | Claim name of the external profile | string Constraints: Min length = 1 Max length = 256 (required) |
| prefix | Prefix for the claim external profile Must be set when the prefixPolicy field is set to 'Prefix' and must be unset otherwise. |
string |
| prefixPolicy | Prefix policy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field. Allowed values are 'Prefix', 'NoPrefix', and 'None'. If not specified, the default policy is 'None'. When set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'. When set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim. When set to 'None', this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends {issuerURL}# to the value of the JWT claimwhen the claim is not 'email'. As an example, consider the following scenario: prefix is unset, issuerURL is set to https://myoidc.tld,the JWT claims include "username":"userA" and "email":"userA |
'None' 'NoPrefix' 'Prefix' |