Skip to search

Workflow

workflow.keycloak.crossplane.io / v1alpha1

apiVersion: workflow.keycloak.crossplane.io/v1alpha1 kind: Workflow metadata: name: example
View raw schema
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 required
WorkflowSpec defines the desired state of Workflow
deletionPolicy string
DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See 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
forProvider object required
cancelInProgress string
Whether to cancel an already in-progress execution when the workflow is re-triggered for the same resource. Set to "true" to enable. Event that cancels an in-progress workflow execution.
conditions string
An expression that must evaluate to true for the workflow to run (e.g. has-role('some-role')). Expression that must be satisfied for the workflow to run.
enabled boolean
Whether the workflow is enabled. Defaults to true. Whether the workflow is enabled.
name string
The name of the workflow. The name of the workflow.
on string
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. The 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.
realm string
The realm this workflow exists in. Changing this forces a new resource. The realm this workflow belongs to.
realmRef object
Reference to a Realm in realm to populate realm.
name string required
Name of the referenced object.
policy object
Policies for referencing.
resolution string
Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.
enum: Required, Optional
resolve string
Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.
enum: Always, IfNotPresent
realmSelector object
Selector for a Realm in realm to populate realm.
matchControllerRef boolean
MatchControllerRef ensures an object with the same controller reference as the selecting object is selected.
matchLabels object
MatchLabels ensures an object with matching labels is selected.
policy object
Policies for selection.
resolution string
Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.
enum: Required, Optional
resolve string
Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.
enum: Always, IfNotPresent
restartInProgress string
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. Event that restarts an in-progress workflow execution.
schedule []object
A schedule block that makes the workflow run periodically over matching realm resources instead of (or in addition to) reacting to a single event. Scheduling configuration for the workflow.
after string
Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d). Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d) or milliseconds.
batchSize number
Maximum number of realm resources processed during each scheduled run. Maximum number of resources processed per scheduled batch.
step []object
One or more step blocks defining the actions to execute, in order. Ordered list of steps to execute.
after string
Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d). Delay before executing this step, as a duration string (e.g. 7d) or milliseconds (e.g. 2592000000).
config object
A map of key-value pairs configuring the step (e.g. emailTemplate for notify-user). Key-value configuration for the step.
priority string
Execution priority used to order steps that would otherwise run at the same time. Execution priority of the step, used to order steps that would otherwise run at the same time.
uses string
The step type. Built-in values: disable-user, delete-user, notify-user, set-user-required-action, set-user-attribute. The step type to execute (e.g. disable-user, delete-user, notify-user).
initProvider object
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
cancelInProgress string
Whether to cancel an already in-progress execution when the workflow is re-triggered for the same resource. Set to "true" to enable. Event that cancels an in-progress workflow execution.
conditions string
An expression that must evaluate to true for the workflow to run (e.g. has-role('some-role')). Expression that must be satisfied for the workflow to run.
enabled boolean
Whether the workflow is enabled. Defaults to true. Whether the workflow is enabled.
name string
The name of the workflow. The name of the workflow.
on string
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. The 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.
realm string
The realm this workflow exists in. Changing this forces a new resource. The realm this workflow belongs to.
realmRef object
Reference to a Realm in realm to populate realm.
name string required
Name of the referenced object.
policy object
Policies for referencing.
resolution string
Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.
enum: Required, Optional
resolve string
Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.
enum: Always, IfNotPresent
realmSelector object
Selector for a Realm in realm to populate realm.
matchControllerRef boolean
MatchControllerRef ensures an object with the same controller reference as the selecting object is selected.
matchLabels object
MatchLabels ensures an object with matching labels is selected.
policy object
Policies for selection.
resolution string
Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.
enum: Required, Optional
resolve string
Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.
enum: Always, IfNotPresent
restartInProgress string
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. Event that restarts an in-progress workflow execution.
schedule []object
A schedule block that makes the workflow run periodically over matching realm resources instead of (or in addition to) reacting to a single event. Scheduling configuration for the workflow.
after string
Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d). Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d) or milliseconds.
batchSize number
Maximum number of realm resources processed during each scheduled run. Maximum number of resources processed per scheduled batch.
step []object
One or more step blocks defining the actions to execute, in order. Ordered list of steps to execute.
after string
Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d). Delay before executing this step, as a duration string (e.g. 7d) or milliseconds (e.g. 2592000000).
config object
A map of key-value pairs configuring the step (e.g. emailTemplate for notify-user). Key-value configuration for the step.
priority string
Execution priority used to order steps that would otherwise run at the same time. Execution priority of the step, used to order steps that would otherwise run at the same time.
uses string
The step type. Built-in values: disable-user, delete-user, notify-user, set-user-required-action, set-user-attribute. The step type to execute (e.g. disable-user, delete-user, notify-user).
managementPolicies []string
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
providerConfigRef object
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
name string required
Name of the referenced object.
policy object
Policies for referencing.
resolution string
Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.
enum: Required, Optional
resolve string
Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.
enum: Always, IfNotPresent
writeConnectionSecretToRef object
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
name string required
Name of the secret.
namespace string required
Namespace of the secret.
status object
WorkflowStatus defines the observed state of Workflow.
atProvider object
cancelInProgress string
Whether to cancel an already in-progress execution when the workflow is re-triggered for the same resource. Set to "true" to enable. Event that cancels an in-progress workflow execution.
conditions string
An expression that must evaluate to true for the workflow to run (e.g. has-role('some-role')). Expression that must be satisfied for the workflow to run.
enabled boolean
Whether the workflow is enabled. Defaults to true. Whether the workflow is enabled.
id string
name string
The name of the workflow. The name of the workflow.
on string
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. The 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.
realm string
The realm this workflow exists in. Changing this forces a new resource. The realm this workflow belongs to.
restartInProgress string
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. Event that restarts an in-progress workflow execution.
schedule []object
A schedule block that makes the workflow run periodically over matching realm resources instead of (or in addition to) reacting to a single event. Scheduling configuration for the workflow.
after string
Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d). Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d) or milliseconds.
batchSize number
Maximum number of realm resources processed during each scheduled run. Maximum number of resources processed per scheduled batch.
state []object
The runtime state of the workflow as reported by Keycloak. Contains: Runtime state of the workflow, as reported by Keycloak.
errors []string
A list of error messages recorded for the workflow.
step []object
One or more step blocks defining the actions to execute, in order. Ordered list of steps to execute.
after string
Interval between successive scheduled runs, as a duration string (e.g. 30s, 1d). Delay before executing this step, as a duration string (e.g. 7d) or milliseconds (e.g. 2592000000).
config object
A map of key-value pairs configuring the step (e.g. emailTemplate for notify-user). Key-value configuration for the step.
priority string
Execution priority used to order steps that would otherwise run at the same time. Execution priority of the step, used to order steps that would otherwise run at the same time.
scheduledAt number
Epoch timestamp in milliseconds at which the step is scheduled to execute. Epoch timestamp in milliseconds at which the step is scheduled to execute.
status string
The execution status of the step. Execution status of the step, as reported by Keycloak.
uses string
The step type. Built-in values: disable-user, delete-user, notify-user, set-user-required-action, set-user-attribute. The step type to execute (e.g. disable-user, delete-user, notify-user).
conditions []object
Conditions of the resource.
lastTransitionTime string required
LastTransitionTime is the last time this condition transitioned from one status to another.
format: date-time
message string
A Message containing details about this condition's last transition from one status to another, if any.
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: int64
reason string required
A Reason for this condition's last transition from one status to another.
status string required
Status of this condition; is it currently True, False, or Unknown?
type string required
Type of this condition. At most one of each condition type may apply to a resource at any point in time.
observedGeneration integer
ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.
format: int64

No matches. Try .spec.deletionPolicy for an exact path