{ "description": "Workflow is the Schema for the Workflows API.", "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", "null" ] }, "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", "null" ] }, "metadata": { "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "WorkflowSpec defines the desired state of Workflow", "properties": { "deletionPolicy": { "default": "Delete", "description": "DeletionPolicy specifies what will happen to the underlying external\nwhen this managed resource is deleted - either \"Delete\" or \"Orphan\" the\nexternal resource.\nThis field is planned to be deprecated in favor of the ManagementPolicies\nfield in a future release. Currently, both could be set independently and\nnon-default values would be honored if the feature flag is enabled.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223", "enum": [ "Orphan", "Delete" ], "type": [ "string", "null" ] }, "forProvider": { "additionalProperties": false, "properties": { "cancelInProgress": { "description": "Whether to cancel an already in-progress execution when the workflow is re-triggered for the same resource. Set to \"true\" to enable.\nEvent that cancels an in-progress workflow execution.", "type": [ "string", "null" ] }, "conditions": { "description": "An expression that must evaluate to true for the workflow to run (e.g. has-role('some-role')).\nExpression that must be satisfied for the workflow to run.", "type": [ "string", "null" ] }, "enabled": { "description": "Whether the workflow is enabled. Defaults to true.\nWhether the workflow is enabled.", "type": [ "boolean", "null" ] }, "name": { "description": "The name of the workflow.\nThe name of the workflow.", "type": [ "string", "null" ] }, "on": { "description": "The realm event that triggers the workflow. Supported values: user_created, user_removed, user_authenticated, user_federated_identity_added, user_federated_identity_removed, user_group_membership_added, user_group_membership_removed, user_role_granted, user_role_revoked.\nThe event that triggers the workflow. Supported values: user_created, user_removed, user_authenticated, user_federated_identity_added, user_federated_identity_removed, user_group_membership_added, user_group_membership_removed, user_role_granted, user_role_revoked.", "type": [ "string", "null" ] }, "realm": { "description": "The realm this workflow exists in. Changing this forces a new resource.\nThe realm this workflow belongs to.", "type": [ "string", "null" ] }, "realmRef": { "additionalProperties": false, "description": "Reference to a Realm in realm to populate realm.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "additionalProperties": false, "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": [ "string", "null" ] }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "realmSelector": { "additionalProperties": false, "description": "Selector for a Realm in realm to populate realm.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": [ "boolean", "null" ] }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": [ "object", "null" ] }, "policy": { "additionalProperties": false, "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": [ "string", "null" ] }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "restartInProgress": { "description": "Whether to restart an already in-progress execution (resetting it to the first step) when the workflow is re-triggered for the same resource. Set to \"true\" to enable.\nEvent that restarts an in-progress workflow execution.", "type": [ "string", "null" ] }, "schedule": { "description": "A schedule block that makes the workflow run periodically over matching realm resources instead of (or in addition to) reacting to a single event.\nScheduling configuration for the workflow.", "items": { "additionalProperties": false, "properties": { "after": { "description": "Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d).\nInterval between successive scheduled runs, as a duration string (e.g. 30s, 1d) or milliseconds.", "type": [ "string", "null" ] }, "batchSize": { "description": "Maximum number of realm resources processed during each scheduled run.\nMaximum number of resources processed per scheduled batch.", "type": [ "number", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "step": { "description": "One or more step blocks defining the actions to execute, in order.\nOrdered list of steps to execute.", "items": { "additionalProperties": false, "properties": { "after": { "description": "Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d).\nDelay before executing this step, as a duration string (e.g. 7d) or milliseconds (e.g. 2592000000).", "type": [ "string", "null" ] }, "config": { "additionalProperties": { "type": "string" }, "description": "A map of key-value pairs configuring the step (e.g. emailTemplate for notify-user).\nKey-value configuration for the step.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "priority": { "description": "Execution priority used to order steps that would otherwise run at the same time.\nExecution priority of the step, used to order steps that would otherwise run at the same time.", "type": [ "string", "null" ] }, "uses": { "description": "The step type. Built-in values: disable-user, delete-user, notify-user, set-user-required-action, set-user-attribute.\nThe step type to execute (e.g. disable-user, delete-user, notify-user).", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "initProvider": { "additionalProperties": false, "description": "THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler.", "properties": { "cancelInProgress": { "description": "Whether to cancel an already in-progress execution when the workflow is re-triggered for the same resource. Set to \"true\" to enable.\nEvent that cancels an in-progress workflow execution.", "type": [ "string", "null" ] }, "conditions": { "description": "An expression that must evaluate to true for the workflow to run (e.g. has-role('some-role')).\nExpression that must be satisfied for the workflow to run.", "type": [ "string", "null" ] }, "enabled": { "description": "Whether the workflow is enabled. Defaults to true.\nWhether the workflow is enabled.", "type": [ "boolean", "null" ] }, "name": { "description": "The name of the workflow.\nThe name of the workflow.", "type": [ "string", "null" ] }, "on": { "description": "The realm event that triggers the workflow. Supported values: user_created, user_removed, user_authenticated, user_federated_identity_added, user_federated_identity_removed, user_group_membership_added, user_group_membership_removed, user_role_granted, user_role_revoked.\nThe event that triggers the workflow. Supported values: user_created, user_removed, user_authenticated, user_federated_identity_added, user_federated_identity_removed, user_group_membership_added, user_group_membership_removed, user_role_granted, user_role_revoked.", "type": [ "string", "null" ] }, "realm": { "description": "The realm this workflow exists in. Changing this forces a new resource.\nThe realm this workflow belongs to.", "type": [ "string", "null" ] }, "realmRef": { "additionalProperties": false, "description": "Reference to a Realm in realm to populate realm.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "additionalProperties": false, "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": [ "string", "null" ] }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "realmSelector": { "additionalProperties": false, "description": "Selector for a Realm in realm to populate realm.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": [ "boolean", "null" ] }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": [ "object", "null" ] }, "policy": { "additionalProperties": false, "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": [ "string", "null" ] }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "restartInProgress": { "description": "Whether to restart an already in-progress execution (resetting it to the first step) when the workflow is re-triggered for the same resource. Set to \"true\" to enable.\nEvent that restarts an in-progress workflow execution.", "type": [ "string", "null" ] }, "schedule": { "description": "A schedule block that makes the workflow run periodically over matching realm resources instead of (or in addition to) reacting to a single event.\nScheduling configuration for the workflow.", "items": { "additionalProperties": false, "properties": { "after": { "description": "Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d).\nInterval between successive scheduled runs, as a duration string (e.g. 30s, 1d) or milliseconds.", "type": [ "string", "null" ] }, "batchSize": { "description": "Maximum number of realm resources processed during each scheduled run.\nMaximum number of resources processed per scheduled batch.", "type": [ "number", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "step": { "description": "One or more step blocks defining the actions to execute, in order.\nOrdered list of steps to execute.", "items": { "additionalProperties": false, "properties": { "after": { "description": "Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d).\nDelay before executing this step, as a duration string (e.g. 7d) or milliseconds (e.g. 2592000000).", "type": [ "string", "null" ] }, "config": { "additionalProperties": { "type": "string" }, "description": "A map of key-value pairs configuring the step (e.g. emailTemplate for notify-user).\nKey-value configuration for the step.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "priority": { "description": "Execution priority used to order steps that would otherwise run at the same time.\nExecution priority of the step, used to order steps that would otherwise run at the same time.", "type": [ "string", "null" ] }, "uses": { "description": "The step type. Built-in values: disable-user, delete-user, notify-user, set-user-required-action, set-user-attribute.\nThe step type to execute (e.g. disable-user, delete-user, notify-user).", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "managementPolicies": { "default": [ "*" ], "description": "THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md", "items": { "description": "A ManagementAction represents an action that the Crossplane controllers\ncan take on an external resource.", "enum": [ "Observe", "Create", "Update", "Delete", "LateInitialize", "*" ], "type": "string" }, "type": [ "array", "null" ] }, "providerConfigRef": { "additionalProperties": false, "default": { "name": "default" }, "description": "ProviderConfigReference specifies how the provider that will be used to\ncreate, observe, update, and delete this managed resource should be\nconfigured.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "additionalProperties": false, "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": [ "string", "null" ] }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "writeConnectionSecretToRef": { "additionalProperties": false, "description": "WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource.", "properties": { "name": { "description": "Name of the secret.", "type": "string" }, "namespace": { "description": "Namespace of the secret.", "type": "string" } }, "required": [ "name", "namespace" ], "type": [ "object", "null" ] } }, "required": [ "forProvider" ], "type": "object", "x-kubernetes-validations": [ { "message": "spec.forProvider.name is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.name) || (has(self.initProvider) \u0026\u0026 has(self.initProvider.name))" }, { "message": "spec.forProvider.on is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.on) || (has(self.initProvider) \u0026\u0026 has(self.initProvider.on))" }, { "message": "spec.forProvider.step is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.step) || (has(self.initProvider) \u0026\u0026 has(self.initProvider.step))" } ] }, "status": { "additionalProperties": false, "description": "WorkflowStatus defines the observed state of Workflow.", "properties": { "atProvider": { "additionalProperties": false, "properties": { "cancelInProgress": { "description": "Whether to cancel an already in-progress execution when the workflow is re-triggered for the same resource. Set to \"true\" to enable.\nEvent that cancels an in-progress workflow execution.", "type": [ "string", "null" ] }, "conditions": { "description": "An expression that must evaluate to true for the workflow to run (e.g. has-role('some-role')).\nExpression that must be satisfied for the workflow to run.", "type": [ "string", "null" ] }, "enabled": { "description": "Whether the workflow is enabled. Defaults to true.\nWhether the workflow is enabled.", "type": [ "boolean", "null" ] }, "id": { "type": [ "string", "null" ] }, "name": { "description": "The name of the workflow.\nThe name of the workflow.", "type": [ "string", "null" ] }, "on": { "description": "The realm event that triggers the workflow. Supported values: user_created, user_removed, user_authenticated, user_federated_identity_added, user_federated_identity_removed, user_group_membership_added, user_group_membership_removed, user_role_granted, user_role_revoked.\nThe event that triggers the workflow. Supported values: user_created, user_removed, user_authenticated, user_federated_identity_added, user_federated_identity_removed, user_group_membership_added, user_group_membership_removed, user_role_granted, user_role_revoked.", "type": [ "string", "null" ] }, "realm": { "description": "The realm this workflow exists in. Changing this forces a new resource.\nThe realm this workflow belongs to.", "type": [ "string", "null" ] }, "restartInProgress": { "description": "Whether to restart an already in-progress execution (resetting it to the first step) when the workflow is re-triggered for the same resource. Set to \"true\" to enable.\nEvent that restarts an in-progress workflow execution.", "type": [ "string", "null" ] }, "schedule": { "description": "A schedule block that makes the workflow run periodically over matching realm resources instead of (or in addition to) reacting to a single event.\nScheduling configuration for the workflow.", "items": { "additionalProperties": false, "properties": { "after": { "description": "Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d).\nInterval between successive scheduled runs, as a duration string (e.g. 30s, 1d) or milliseconds.", "type": [ "string", "null" ] }, "batchSize": { "description": "Maximum number of realm resources processed during each scheduled run.\nMaximum number of resources processed per scheduled batch.", "type": [ "number", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "state": { "description": "The runtime state of the workflow as reported by Keycloak. Contains:\nRuntime state of the workflow, as reported by Keycloak.", "items": { "additionalProperties": false, "properties": { "errors": { "description": "A list of error messages recorded for the workflow.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "step": { "description": "One or more step blocks defining the actions to execute, in order.\nOrdered list of steps to execute.", "items": { "additionalProperties": false, "properties": { "after": { "description": "Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d).\nDelay before executing this step, as a duration string (e.g. 7d) or milliseconds (e.g. 2592000000).", "type": [ "string", "null" ] }, "config": { "additionalProperties": { "type": "string" }, "description": "A map of key-value pairs configuring the step (e.g. emailTemplate for notify-user).\nKey-value configuration for the step.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "priority": { "description": "Execution priority used to order steps that would otherwise run at the same time.\nExecution priority of the step, used to order steps that would otherwise run at the same time.", "type": [ "string", "null" ] }, "scheduledAt": { "description": "Epoch timestamp in milliseconds at which the step is scheduled to execute.\nEpoch timestamp in milliseconds at which the step is scheduled to execute.", "type": [ "number", "null" ] }, "status": { "description": "The execution status of the step.\nExecution status of the step, as reported by Keycloak.", "type": [ "string", "null" ] }, "uses": { "description": "The step type. Built-in values: disable-user, delete-user, notify-user, set-user-required-action, set-user-attribute.\nThe step type to execute (e.g. disable-user, delete-user, notify-user).", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "conditions": { "description": "Conditions of the resource.", "items": { "additionalProperties": false, "description": "A Condition that may apply to a resource.", "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the last time this condition transitioned from one\nstatus to another.", "format": "date-time", "type": "string" }, "message": { "description": "A Message containing details about this condition's last transition from\none status to another, if any.", "type": [ "string", "null" ] }, "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", "type": [ "integer", "null" ] }, "reason": { "description": "A Reason for this condition's last transition from one status to another.", "type": "string" }, "status": { "description": "Status of this condition; is it currently True, False, or Unknown?", "type": "string" }, "type": { "description": "Type of this condition. At most one of each condition type may apply to\na resource at any point in time.", "type": "string" } }, "required": [ "lastTransitionTime", "reason", "status", "type" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "observedGeneration": { "description": "ObservedGeneration is the latest metadata.generation\nwhich resulted in either a ready state, or stalled due to error\nit can not recover from without human intervention.", "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "spec" ], "type": "object" }