KeycloakClient
keycloak.hostzero.com / v1beta1
apiVersion: keycloak.hostzero.com/v1beta1
kind: KeycloakClient
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
KeycloakClientSpec defines the desired state of KeycloakClient
clientId
string
ClientId is the client ID in Keycloak (defaults to metadata.name)
clientSecretRef object
ClientSecretRef configures the Kubernetes Secret for client credentials.
If the secret exists, its value is used. If it doesn't exist and Create is true,
the operator auto-generates a secret and creates it.
For public clients (publicClient: true) the Secret is still materialised
when ClientSecretRef is set, but only contains the client-id key — there
is no client_secret to store.
clientIdKey
string
ClientIdKey is the key for the client ID in the secret.
Defaults to "client-id".
clientSecretKey
string
ClientSecretKey is the key for the client secret value in the secret.
Defaults to "client-secret".
create
boolean
Create determines behavior when the secret doesn't exist.
If true (default): auto-generate a secret and create the Secret.
If false: error if the secret doesn't exist (strict mode for GitOps).
name
string required
Name of the Kubernetes Secret
clusterRealmRef object
ClusterRealmRef is a reference to a ClusterKeycloakRealm
One of realmRef or clusterRealmRef must be specified
name
string required
Name of the cluster-scoped resource
definition
object
Definition contains the Keycloak ClientRepresentation
realmRef object
RealmRef is a reference to a KeycloakRealm
One of realmRef or clusterRealmRef must be specified
name
string required
Name of the resource
namespace
string
Namespace of the resource (optional, defaults to the same namespace)
status object
KeycloakClientStatus defines the observed state of KeycloakClient
clientUUID
string
ClientUUID is the Keycloak internal ID
conditions []object
Conditions represent the latest available observations
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316instance object
Instance contains the resolved instance reference
clusterInstanceRef
string
ClusterInstanceRef is the name of the cluster instance
instanceRef
string
InstanceRef is the name of the namespaced instance
message
string
Message contains additional information
observedGeneration
integer
ObservedGeneration is the generation of the spec that was last processed
format:
int64
ready
boolean required
Ready indicates if the client is ready
realm object
Realm contains the resolved realm reference
clusterRealmRef
string
ClusterRealmRef is the name of the cluster realm
realmRef
string
RealmRef is the name of the namespaced realm
resourcePath
string
ResourcePath is the Keycloak API path for this client
status
string
Status is a human-readable status message
No matches. Try .spec.clientId for an exact path