KeycloakProtocolMapper

v1

resource to define a Protocol Mapper within either a KeycloakClient or a KeycloakClientScope

Property	Type	Required
spec	object	✅
spec.clientRef	string
spec.clientScopeRef	string
spec.definition	object	✅
spec.definition.config	object
spec.definition.consentRequired	boolean
spec.definition.consentText	string
spec.definition.id	string
spec.definition.name	string
spec.definition.protocol	string
spec.definition.protocolMapper	string
spec.options	object
spec.patchFrom	object
status	object
status.conditions[]	object
status.conditions[].lastTransitionTime	string
status.conditions[].lastUpdateTime	string
status.conditions[].message	string
status.conditions[].reason	string
status.conditions[].status	string	✅
status.conditions[].type	string	✅
status.message	string
status.ready	boolean	✅
status.resourcePath	string
status.status	string

spec

Type: object

Property	Type	Required
clientRef	string
clientScopeRef	string
definition	object	✅
options	object
patchFrom	object

the KeycloakProtocolMapper resource

spec.clientRef

Type: string

missing

spec.clientScopeRef

Type: string

missing

spec.definition

Type: object

Property	Type	Required
config	object
consentRequired	boolean
consentText	string
id	string
name	string
protocol	string
protocolMapper	string

Validation Rule	Error Message
has(self.id) == has(oldSelf.id)	Value is immutable

missing

spec.definition.config

Type: object

missing

spec.definition.consentRequired

Type: boolean

missing

spec.definition.consentText

Type: string

missing

spec.definition.id

Type: string

Validation Rule	Error Message
self == oldSelf	Value is immutable

missing

spec.definition.name

Type: string

missing

spec.definition.protocol

Type: string

missing

spec.definition.protocolMapper

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.

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.