KeycloakClient
v1
resource to define a Client within a KeycloakRealm
spec
Type: object
| Property | Type | Required |
|---|---|---|
| clientSecret | object | |
| definition | object | ✅ |
| options | object | |
| patchFrom | object | |
| realmRef | string | ✅ |
the KeycloakClient resource
spec.clientSecret
Type: object
| Property | Type | Required |
|---|---|---|
| clientIdKey | string | |
| clientSecretKey | string | |
| secretName | string | ✅ |
missing
spec.clientSecret.clientIdKey
Type: string
missing
spec.clientSecret.clientSecretKey
Type: string
missing
spec.clientSecret.secretName
Type: string
missing
spec.definition
Type: object
| Property | Type | Required |
|---|---|---|
| access | object | |
| adminUrl | string | |
| alwaysDisplayInConsole | boolean | |
| attributes | object | |
| authenticationFlowBindingOverrides | object | |
| authorizationServicesEnabled | boolean | |
| authorizationSettings | object | |
| baseUrl | string | |
| bearerOnly | boolean | |
| clientAuthenticatorType | string | |
| clientId | string | |
| clientTemplate | string | |
| consentRequired | boolean | |
| defaultClientScopes[] | string | |
| defaultRoles[] | string | |
| description | string | |
| directAccessGrantsEnabled | boolean | |
| directGrantsOnly | boolean | |
| enabled | boolean | |
| frontchannelLogout | boolean | |
| fullScopeAllowed | boolean | |
| id | string | |
| implicitFlowEnabled | boolean | |
| name | string | |
| nodeReRegistrationTimeout | integer | |
| notBefore | integer | |
| optionalClientScopes[] | string | |
| origin | string | |
| protocol | string | |
| protocolMappers[] | object | |
| publicClient | boolean | |
| redirectUris[] | string | |
| registeredNodes | object | |
| registrationAccessToken | string | |
| rootUrl | string | |
| secret | string | |
| serviceAccountsEnabled | boolean | |
| standardFlowEnabled | boolean | |
| surrogateAuthRequired | boolean | |
| type | string | |
| useTemplateConfig | boolean | |
| useTemplateMappers | boolean | |
| useTemplateScope | boolean | |
| webOrigins[] | string |
| Validation Rule | Error Message |
|---|---|
| has(self.id) == has(oldSelf.id) | Value is immutable |
missing
spec.definition.access
Type: object
missing
spec.definition.adminUrl
Type: string
missing
spec.definition.alwaysDisplayInConsole
Type: boolean
missing
spec.definition.attributes
Type: object
missing
spec.definition.authenticationFlowBindingOverrides
Type: object
missing
spec.definition.authorizationServicesEnabled
Type: boolean
missing
spec.definition.authorizationSettings
Type: object
| Property | Type | Required |
|---|---|---|
| allowRemoteResourceManagement | boolean | |
| clientId | string | |
| decisionStrategy | string | |
| id | string | |
| name | string | |
| policies[] | object | |
| policyEnforcementMode | string | |
| resources[] | object | |
| scopes[] | object |
missing
spec.definition.authorizationSettings.allowRemoteResourceManagement
Type: boolean
missing
spec.definition.authorizationSettings.clientId
Type: string
missing
spec.definition.authorizationSettings.decisionStrategy
Type: string
missing
spec.definition.authorizationSettings.id
Type: string
missing
spec.definition.authorizationSettings.name
Type: string
missing
spec.definition.authorizationSettings.policies[]
Type: object
| Property | Type | Required |
|---|---|---|
| config | object | |
| decisionStrategy | string | |
| description | string | |
| id | string | |
| logic | string | |
| name | string | |
| owner | string | |
| policies[] | string | |
| resources[] | string | |
| resourcesData[] | object | |
| scopes[] | string | |
| scopesData[] | object | |
| type | string |
missing
spec.definition.authorizationSettings.policies[].config
Type: object
missing
spec.definition.authorizationSettings.policies[].decisionStrategy
Type: string
missing
spec.definition.authorizationSettings.policies[].description
Type: string
missing
spec.definition.authorizationSettings.policies[].id
Type: string
missing
spec.definition.authorizationSettings.policies[].logic
Type: string
missing
spec.definition.authorizationSettings.policies[].name
Type: string
missing
spec.definition.authorizationSettings.policies[].owner
Type: string
missing
spec.definition.authorizationSettings.policies[].policies[]
Type: string
missing
spec.definition.authorizationSettings.policies[].resources[]
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[]
Type: object
| Property | Type | Required |
|---|---|---|
| _id | string | |
| attributes | object | |
| displayName | string | |
| icon_uri | string | |
| name | string | |
| owner | object | |
| ownerManagedAccess | boolean | |
| scopes[] | object | |
| scopesUma[] | object | |
| type | string | |
| uri | string | |
| uris[] | string |
missing
spec.definition.authorizationSettings.policies[].resourcesData[]._id
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].attributes
Type: object
missing
spec.definition.authorizationSettings.policies[].resourcesData[].displayName
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].icon_uri
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].name
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].owner
Type: object
missing
spec.definition.authorizationSettings.policies[].resourcesData[].owner.id
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].owner.name
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].ownerManagedAccess
Type: boolean
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopes[]
Type: object
| Property | Type | Required |
|---|---|---|
| displayName | string | |
| iconUri | string | |
| id | string | |
| name | string |
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopes[].displayName
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopes[].iconUri
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopes[].id
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopes[].name
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopesUma[]
Type: object
| Property | Type | Required |
|---|---|---|
| displayName | string | |
| iconUri | string | |
| id | string | |
| name | string |
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopesUma[].displayName
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopesUma[].iconUri
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopesUma[].id
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].scopesUma[].name
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].type
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].uri
Type: string
missing
spec.definition.authorizationSettings.policies[].resourcesData[].uris[]
Type: string
missing
spec.definition.authorizationSettings.policies[].scopes[]
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[]
Type: object
| Property | Type | Required |
|---|---|---|
| displayName | string | |
| iconUri | string | |
| id | string | |
| name | string | |
| resources[] | object |
missing
spec.definition.authorizationSettings.policies[].scopesData[].displayName
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].iconUri
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].id
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].name
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[]
Type: object
| Property | Type | Required |
|---|---|---|
| _id | string | |
| attributes | object | |
| displayName | string | |
| icon_uri | string | |
| name | string | |
| owner | object | |
| ownerManagedAccess | boolean | |
| type | string | |
| uri | string | |
| uris[] | string |
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[]._id
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].attributes
Type: object
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].displayName
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].icon_uri
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].name
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].owner
Type: object
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].owner.id
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].owner.name
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].ownerManagedAccess
Type: boolean
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].type
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].uri
Type: string
missing
spec.definition.authorizationSettings.policies[].scopesData[].resources[].uris[]
Type: string
missing
spec.definition.authorizationSettings.policies[].type
Type: string
missing
spec.definition.authorizationSettings.policyEnforcementMode
Type: string
missing
spec.definition.authorizationSettings.resources[]
Type: object
| Property | Type | Required |
|---|---|---|
| _id | string | |
| attributes | object | |
| displayName | string | |
| icon_uri | string | |
| name | string | |
| owner | object | |
| ownerManagedAccess | boolean | |
| scopes[] | object | |
| scopesUma[] | object | |
| type | string | |
| uri | string | |
| uris[] | string |
missing
spec.definition.authorizationSettings.resources[]._id
Type: string
missing
spec.definition.authorizationSettings.resources[].attributes
Type: object
missing
spec.definition.authorizationSettings.resources[].displayName
Type: string
missing
spec.definition.authorizationSettings.resources[].icon_uri
Type: string
missing
spec.definition.authorizationSettings.resources[].name
Type: string
missing
spec.definition.authorizationSettings.resources[].owner
Type: object
missing
spec.definition.authorizationSettings.resources[].owner.id
Type: string
missing
spec.definition.authorizationSettings.resources[].owner.name
Type: string
missing
spec.definition.authorizationSettings.resources[].ownerManagedAccess
Type: boolean
missing
spec.definition.authorizationSettings.resources[].scopes[]
Type: object
| Property | Type | Required |
|---|---|---|
| displayName | string | |
| iconUri | string | |
| id | string | |
| name | string | |
| policies[] | object |
missing
spec.definition.authorizationSettings.resources[].scopes[].displayName
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].iconUri
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].id
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].name
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[]
Type: object
| Property | Type | Required |
|---|---|---|
| config | object | |
| decisionStrategy | string | |
| description | string | |
| id | string | |
| logic | string | |
| name | string | |
| owner | string | |
| policies[] | string | |
| resources[] | string | |
| scopes[] | string | |
| type | string |
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].config
Type: object
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].decisionStrategy
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].description
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].id
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].logic
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].name
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].owner
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].policies[]
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].resources[]
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].scopes[]
Type: string
missing
spec.definition.authorizationSettings.resources[].scopes[].policies[].type
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[]
Type: object
| Property | Type | Required |
|---|---|---|
| displayName | string | |
| iconUri | string | |
| id | string | |
| name | string | |
| policies[] | object |
missing
spec.definition.authorizationSettings.resources[].scopesUma[].displayName
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].iconUri
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].id
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].name
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[]
Type: object
| Property | Type | Required |
|---|---|---|
| config | object | |
| decisionStrategy | string | |
| description | string | |
| id | string | |
| logic | string | |
| name | string | |
| owner | string | |
| policies[] | string | |
| resources[] | string | |
| scopes[] | string | |
| type | string |
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].config
Type: object
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].decisionStrategy
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].description
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].id
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].logic
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].name
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].owner
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].policies[]
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].resources[]
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].scopes[]
Type: string
missing
spec.definition.authorizationSettings.resources[].scopesUma[].policies[].type
Type: string
missing
spec.definition.authorizationSettings.resources[].type
Type: string
missing
spec.definition.authorizationSettings.resources[].uri
Type: string
missing
spec.definition.authorizationSettings.resources[].uris[]
Type: string
missing
spec.definition.authorizationSettings.scopes[]
Type: object
| Property | Type | Required |
|---|---|---|
| displayName | string | |
| iconUri | string | |
| id | string | |
| name | string | |
| policies[] | object | |
| resources[] | object |
missing
spec.definition.authorizationSettings.scopes[].displayName
Type: string
missing
spec.definition.authorizationSettings.scopes[].iconUri
Type: string
missing
spec.definition.authorizationSettings.scopes[].id
Type: string
missing
spec.definition.authorizationSettings.scopes[].name
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[]
Type: object
| Property | Type | Required |
|---|---|---|
| config | object | |
| decisionStrategy | string | |
| description | string | |
| id | string | |
| logic | string | |
| name | string | |
| owner | string | |
| policies[] | string | |
| resources[] | string | |
| resourcesData[] | object | |
| scopes[] | string | |
| type | string |
missing
spec.definition.authorizationSettings.scopes[].policies[].config
Type: object
missing
spec.definition.authorizationSettings.scopes[].policies[].decisionStrategy
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].description
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].id
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].logic
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].name
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].owner
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].policies[]
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resources[]
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[]
Type: object
| Property | Type | Required |
|---|---|---|
| _id | string | |
| attributes | object | |
| displayName | string | |
| icon_uri | string | |
| name | string | |
| owner | object | |
| ownerManagedAccess | boolean | |
| type | string | |
| uri | string | |
| uris[] | string |
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[]._id
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].attributes
Type: object
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].displayName
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].icon_uri
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].name
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].owner
Type: object
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].owner.id
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].owner.name
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].ownerManagedAccess
Type: boolean
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].type
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].uri
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].resourcesData[].uris[]
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].scopes[]
Type: string
missing
spec.definition.authorizationSettings.scopes[].policies[].type
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[]
Type: object
| Property | Type | Required |
|---|---|---|
| _id | string | |
| attributes | object | |
| displayName | string | |
| icon_uri | string | |
| name | string | |
| owner | object | |
| ownerManagedAccess | boolean | |
| type | string | |
| uri | string | |
| uris[] | string |
missing
spec.definition.authorizationSettings.scopes[].resources[]._id
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].attributes
Type: object
missing
spec.definition.authorizationSettings.scopes[].resources[].displayName
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].icon_uri
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].name
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].owner
Type: object
missing
spec.definition.authorizationSettings.scopes[].resources[].owner.id
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].owner.name
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].ownerManagedAccess
Type: boolean
missing
spec.definition.authorizationSettings.scopes[].resources[].type
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].uri
Type: string
missing
spec.definition.authorizationSettings.scopes[].resources[].uris[]
Type: string
missing
spec.definition.baseUrl
Type: string
missing
spec.definition.bearerOnly
Type: boolean
missing
spec.definition.clientAuthenticatorType
Type: string
missing
spec.definition.clientId
Type: string
missing
spec.definition.clientTemplate
Type: string
missing
spec.definition.consentRequired
Type: boolean
missing
spec.definition.defaultClientScopes[]
Type: string
missing
spec.definition.defaultRoles[]
Type: string
missing
spec.definition.description
Type: string
missing
spec.definition.directAccessGrantsEnabled
Type: boolean
missing
spec.definition.directGrantsOnly
Type: boolean
missing
spec.definition.enabled
Type: boolean
missing
spec.definition.frontchannelLogout
Type: boolean
missing
spec.definition.fullScopeAllowed
Type: boolean
missing
spec.definition.id
Type: string
| Validation Rule | Error Message |
|---|---|
| self == oldSelf | Value is immutable |
missing
spec.definition.implicitFlowEnabled
Type: boolean
missing
spec.definition.name
Type: string
missing
spec.definition.nodeReRegistrationTimeout
Type: integer
missing
spec.definition.notBefore
Type: integer
missing
spec.definition.optionalClientScopes[]
Type: string
missing
spec.definition.origin
Type: string
missing
spec.definition.protocol
Type: string
missing
spec.definition.protocolMappers[]
Type: object
| Property | Type | Required |
|---|---|---|
| config | object | |
| consentRequired | boolean | |
| consentText | string | |
| id | string | |
| name | string | |
| protocol | string | |
| protocolMapper | string |
missing
spec.definition.protocolMappers[].config
Type: object
missing
spec.definition.protocolMappers[].consentRequired
Type: boolean
missing
spec.definition.protocolMappers[].consentText
Type: string
missing
spec.definition.protocolMappers[].id
Type: string
missing
spec.definition.protocolMappers[].name
Type: string
missing
spec.definition.protocolMappers[].protocol
Type: string
missing
spec.definition.protocolMappers[].protocolMapper
Type: string
missing
spec.definition.publicClient
Type: boolean
missing
spec.definition.redirectUris[]
Type: string
missing
spec.definition.registeredNodes
Type: object
missing
spec.definition.registrationAccessToken
Type: string
missing
spec.definition.rootUrl
Type: string
missing
spec.definition.secret
Type: string
missing
spec.definition.serviceAccountsEnabled
Type: boolean
missing
spec.definition.standardFlowEnabled
Type: boolean
missing
spec.definition.surrogateAuthRequired
Type: boolean
missing
spec.definition.type
Type: string
missing
spec.definition.useTemplateConfig
Type: boolean
missing
spec.definition.useTemplateMappers
Type: boolean
missing
spec.definition.useTemplateScope
Type: boolean
missing
spec.definition.webOrigins[]
Type: string
missing
spec.options
Type: object
Options for the request to the Keycloak Admin API.
spec.patchFrom
Type: object
Defines additional values that can be loaded from secrets or configmaps. Field selectors are not supported. For more informations see the patches documentation.
spec.realmRef
Type: string
the name of the kubernetes object that created the realm.
status
Type: object
| Property | Type | Required |
|---|---|---|
| conditions[] | object | |
| message | string | |
| ready | boolean | ✅ |
| resourcePath | string | |
| status | string |
missing
status.conditions[]
Type: object
| Property | Type | Required |
|---|---|---|
| lastTransitionTime | string | |
| lastUpdateTime | string | |
| message | string | |
| reason | string | |
| status | string | ✅ |
| type | string | ✅ |
missing
status.conditions[].lastTransitionTime
Type: string
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
status.conditions[].lastUpdateTime
Type: string
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
status.conditions[].message
Type: string
missing
status.conditions[].reason
Type: string
missing
status.conditions[].status
Type: string
missing
status.conditions[].type
Type: string
missing
status.message
Type: string
missing
status.ready
Type: boolean
missing
status.resourcePath
Type: string
missing
status.status
Type: string
missing