274 lines
10 KiB
JSON
274 lines
10 KiB
JSON
{
|
|
"description": "KeycloakRoleMapping maps a role to a user or group",
|
|
"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": "KeycloakRoleMappingSpec defines the desired state of KeycloakRoleMapping",
|
|
"properties": {
|
|
"role": {
|
|
"description": "Role defines the role to assign (inline definition)\nEither Role or RoleRef must be specified",
|
|
"properties": {
|
|
"clientId": {
|
|
"description": "ClientID is the client ID for client-level roles (alternative to ClientRef)",
|
|
"type": "string"
|
|
},
|
|
"clientRef": {
|
|
"description": "ClientRef references a KeycloakClient for client-level roles\nIf not specified, the role is a realm-level role",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"name": {
|
|
"description": "Name is the role name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"x-kubernetes-validations": [
|
|
{
|
|
"message": "at most one of clientRef or clientId may be set",
|
|
"rule": "!(has(self.clientRef) && has(self.clientId))"
|
|
}
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"roleRef": {
|
|
"description": "RoleRef references an existing KeycloakRole resource\nEither Role or RoleRef must be specified",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"subject": {
|
|
"description": "Subject defines who the role is assigned to (user or group)",
|
|
"properties": {
|
|
"groupRef": {
|
|
"description": "GroupRef references a KeycloakGroup",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"serviceAccountRef": {
|
|
"description": "ServiceAccountRef references a KeycloakClient to assign roles to its\nauto-created service account user. This avoids needing an intermediate\nKeycloakUser CR for clients with serviceAccountsEnabled: true.",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"userRef": {
|
|
"description": "UserRef references a KeycloakUser",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Name of the resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"type": "object",
|
|
"x-kubernetes-validations": [
|
|
{
|
|
"message": "exactly one of userRef, groupRef, or serviceAccountRef must be set",
|
|
"rule": "(has(self.userRef) ? 1 : 0) + (has(self.groupRef) ? 1 : 0) + (has(self.serviceAccountRef) ? 1 : 0) == 1"
|
|
}
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"required": [
|
|
"subject"
|
|
],
|
|
"type": "object",
|
|
"x-kubernetes-validations": [
|
|
{
|
|
"message": "exactly one of role or roleRef must be set",
|
|
"rule": "has(self.role) != has(self.roleRef)"
|
|
}
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"status": {
|
|
"description": "KeycloakRoleMappingStatus defines the observed state of KeycloakRoleMapping",
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"observedGeneration": {
|
|
"description": "ObservedGeneration is the generation of the spec that was last processed",
|
|
"format": "int64",
|
|
"type": "integer"
|
|
},
|
|
"ready": {
|
|
"description": "Ready indicates if the role mapping is applied",
|
|
"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 role mapping",
|
|
"type": "string"
|
|
},
|
|
"roleName": {
|
|
"description": "RoleName is the resolved role name",
|
|
"type": "string"
|
|
},
|
|
"roleType": {
|
|
"description": "RoleType is either \"realm\" or \"client\"",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status is a human-readable status message",
|
|
"type": "string"
|
|
},
|
|
"subjectID": {
|
|
"description": "SubjectID is the Keycloak ID of the subject",
|
|
"type": "string"
|
|
},
|
|
"subjectType": {
|
|
"description": "SubjectType is either \"user\" or \"group\"",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"ready"
|
|
],
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|