211 lines
8.4 KiB
JSON
211 lines
8.4 KiB
JSON
{
|
|
"description": "KeycloakGroup defines a group within a KeycloakRealm",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object"
|
|
},
|
|
"spec": {
|
|
"description": "KeycloakGroupSpec defines the desired state of KeycloakGroup",
|
|
"properties": {
|
|
"clusterRealmRef": {
|
|
"description": "ClusterRealmRef is a reference to a ClusterKeycloakRealm for top-level groups\nOne of realmRef, clusterRealmRef, or parentGroupRef must be specified",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the cluster-scoped resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"definition": {
|
|
"description": "Definition contains the Keycloak GroupRepresentation. Set the group name\nvia spec.name.",
|
|
"type": "object",
|
|
"x-kubernetes-preserve-unknown-fields": true
|
|
},
|
|
"name": {
|
|
"description": "Name is the group name in Keycloak. Immutable once set.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"parentGroupRef": {
|
|
"description": "ParentGroupRef is a reference to a parent KeycloakGroup for nested groups.\nThe realm is derived from the parent chain, so realmRef and clusterRealmRef\nmust not be set alongside it.\nOne of realmRef, clusterRealmRef, or parentGroupRef must be specified",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"realmRef": {
|
|
"description": "RealmRef is a reference to a KeycloakRealm for top-level groups\nOne of realmRef, clusterRealmRef, or parentGroupRef must be specified",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"required": [
|
|
"definition",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"x-kubernetes-validations": [
|
|
{
|
|
"message": "exactly one of realmRef, clusterRealmRef, or parentGroupRef must be set",
|
|
"rule": "(has(self.realmRef) ? 1 : 0) + (has(self.clusterRealmRef) ? 1 : 0) + (has(self.parentGroupRef) ? 1 : 0) == 1"
|
|
},
|
|
{
|
|
"message": "spec.name is immutable once set",
|
|
"rule": "!has(oldSelf.name) || self.name == oldSelf.name"
|
|
}
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"status": {
|
|
"description": "KeycloakGroupStatus defines the observed state of KeycloakGroup",
|
|
"properties": {
|
|
"conditions": {
|
|
"description": "Conditions represent the latest available observations",
|
|
"items": {
|
|
"description": "Condition contains details for one aspect of the current state of this API Resource.",
|
|
"properties": {
|
|
"lastTransitionTime": {
|
|
"description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
|
|
"maxLength": 32768,
|
|
"type": "string"
|
|
},
|
|
"observedGeneration": {
|
|
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
|
|
"format": "int64",
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"reason": {
|
|
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
|
|
"maxLength": 1024,
|
|
"minLength": 1,
|
|
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "status of the condition, one of True, False, Unknown.",
|
|
"enum": [
|
|
"True",
|
|
"False",
|
|
"Unknown"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "type of condition in CamelCase or in foo.example.com/CamelCase.",
|
|
"maxLength": 316,
|
|
"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])$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"lastTransitionTime",
|
|
"message",
|
|
"reason",
|
|
"status",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"type": "array"
|
|
},
|
|
"groupID": {
|
|
"description": "GroupID is the Keycloak internal group ID",
|
|
"type": "string"
|
|
},
|
|
"groupName": {
|
|
"description": "GroupName is the resolved group name in Keycloak",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"description": "Instance contains the resolved instance reference",
|
|
"properties": {
|
|
"clusterInstanceRef": {
|
|
"description": "ClusterInstanceRef is the name of the cluster instance",
|
|
"type": "string"
|
|
},
|
|
"instanceRef": {
|
|
"description": "InstanceRef is the name of the namespaced instance",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"message": {
|
|
"description": "Message contains additional information",
|
|
"type": "string"
|
|
},
|
|
"ready": {
|
|
"description": "Ready indicates if the group is ready",
|
|
"type": "boolean"
|
|
},
|
|
"realm": {
|
|
"description": "Realm contains the resolved realm reference",
|
|
"properties": {
|
|
"clusterRealmRef": {
|
|
"description": "ClusterRealmRef is the name of the cluster realm",
|
|
"type": "string"
|
|
},
|
|
"realmRef": {
|
|
"description": "RealmRef is the name of the namespaced realm",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"resourcePath": {
|
|
"description": "ResourcePath is the Keycloak API path for this group",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status is a human-readable status message",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"ready"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|