KeycloakApiObject

v1

Custom Resource for Keycloak API requests. The user should not use this resource directly.

Property	Type	Required
spec	object	✅
spec.endpoint	object	✅
spec.endpoint.instanceRef	string	✅
spec.endpoint.path	string	✅
spec.immutablePayload	string	✅
spec.options	object
spec.payload	string	✅
spec.vars[]	object
spec.vars[].name	string	✅
spec.vars[].value	string
spec.vars[].valueFrom	object
spec.vars[].valueFrom.configMapKeyRef	object
spec.vars[].valueFrom.configMapKeyRef.key	string	✅
spec.vars[].valueFrom.configMapKeyRef.name	string	✅
spec.vars[].valueFrom.configMapKeyRef.optional	boolean
spec.vars[].valueFrom.fieldRef	object
spec.vars[].valueFrom.fieldRef.apiVersion	string
spec.vars[].valueFrom.fieldRef.fieldPath	string	✅
spec.vars[].valueFrom.resourceFieldRef	object
spec.vars[].valueFrom.resourceFieldRef.containerName	string
spec.vars[].valueFrom.resourceFieldRef.divisor	string
spec.vars[].valueFrom.resourceFieldRef.resource	string	✅
spec.vars[].valueFrom.secretKeyRef	object
spec.vars[].valueFrom.secretKeyRef.key	string	✅
spec.vars[].valueFrom.secretKeyRef.name	string	✅
spec.vars[].valueFrom.secretKeyRef.optional	boolean
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
endpoint	object	✅
immutablePayload	string	✅
options	object
payload	string	✅
vars[]	object

defines an API request to the Keycloak Admin API.

Property	Type	Required
instanceRef	string	✅
path	string	✅

Validation Rule	Error Message
self == oldSelf	Value is immutable

Validation Rule	Error Message
self == oldSelf	Value is immutable

Validation Rule	Error Message
self == oldSelf	Value is immutable

spec.options

Type: object

Options for the request to the Keycloak Admin API.

spec.vars[]

Type: object

Property	Type	Required
name	string	✅
value	string
valueFrom	object

EnvVar represents an environment variable present in a Container.

spec.vars[].name

Type: string

Name of the environment variable. Must be a C_IDENTIFIER.

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

spec.vars[].valueFrom

Type: object

Property	Type	Required
configMapKeyRef	object
fieldRef	object
resourceFieldRef	object
secretKeyRef	object

Source for the environment variable's value. Cannot be used if value is not empty.

spec.vars[].valueFrom.configMapKeyRef

Type: object

Property	Type	Required
key	string	✅
name	string	✅
optional	boolean

Selects a key of a ConfigMap.

spec.vars[].valueFrom.configMapKeyRef.key

Type: string

The key to select.

spec.vars[].valueFrom.configMapKeyRef.name

Type: string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

spec.vars[].valueFrom.configMapKeyRef.optional

Type: boolean

Specify whether the ConfigMap or its key must be defined

spec.vars[].valueFrom.fieldRef

Type: object

Property	Type	Required
apiVersion	string
fieldPath	string	✅

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

spec.vars[].valueFrom.fieldRef.apiVersion

Type: string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

spec.vars[].valueFrom.fieldRef.fieldPath

Type: string

Path of the field to select in the specified API version.

spec.vars[].valueFrom.resourceFieldRef

Type: object

Property	Type	Required
containerName	string
divisor	string
resource	string	✅

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.