Skip to search

UserFederation

user.keycloak.crossplane.io / v1alpha1

apiVersion: user.keycloak.crossplane.io/v1alpha1 kind: UserFederation 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
UserFederationSpec defines the desired state of UserFederation
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
cachePolicy string
Can be one of DEFAULT, EVICT_DAILY, EVICT_WEEKLY, MAX_LIFESPAN, or NO_CACHE. Defaults to DEFAULT.
changedSyncPeriod number
How frequently Keycloak should sync changed users, in seconds. Omit this property to disable periodic changed users sync. How frequently Keycloak should sync changed users, in seconds. Omit this property to disable periodic changed users sync.
config object
The provider configuration handed over to your custom user federation provider. To give a setting more than one value, join the values with ##; each value is stored separately in Keycloak.
enabled boolean
When false, this provider will not be used when performing queries for users. Defaults to true. When false, this provider will not be used when performing queries for users.
fullSyncPeriod number
How frequently Keycloak should sync all users, in seconds. Omit this property to disable periodic full sync. How frequently Keycloak should sync all users, in seconds. Omit this property to disable periodic full sync.
name string
Display name of the provider when displayed in the console. Display name of the provider when displayed in the console.
parentId string
Must be set to the realms' internal_id when it differs from the realm. This can happen when existing resources are imported into the state. The parent_id of the generated component. will use realm_id if not specified.
priority number
Priority of this provider when looking up users. Lower values are first. Defaults to 0. Priority of this provider when looking up users. Lower values are first.
providerId string
The unique ID of the custom provider, specified in the getId implementation for the UserStorageProviderFactory interface. The unique ID of the custom provider, specified in the `getId` implementation for the UserStorageProviderFactory interface
realmId string
The realm that this provider will provide user federation for. The realm (name) this provider will provide user federation for.
realmIdRef object
Reference to a Realm in realm to populate realmId.
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
realmIdSelector object
Selector for a Realm in realm to populate realmId.
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
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.
cachePolicy string
Can be one of DEFAULT, EVICT_DAILY, EVICT_WEEKLY, MAX_LIFESPAN, or NO_CACHE. Defaults to DEFAULT.
changedSyncPeriod number
How frequently Keycloak should sync changed users, in seconds. Omit this property to disable periodic changed users sync. How frequently Keycloak should sync changed users, in seconds. Omit this property to disable periodic changed users sync.
config object
The provider configuration handed over to your custom user federation provider. To give a setting more than one value, join the values with ##; each value is stored separately in Keycloak.
enabled boolean
When false, this provider will not be used when performing queries for users. Defaults to true. When false, this provider will not be used when performing queries for users.
fullSyncPeriod number
How frequently Keycloak should sync all users, in seconds. Omit this property to disable periodic full sync. How frequently Keycloak should sync all users, in seconds. Omit this property to disable periodic full sync.
name string
Display name of the provider when displayed in the console. Display name of the provider when displayed in the console.
parentId string
Must be set to the realms' internal_id when it differs from the realm. This can happen when existing resources are imported into the state. The parent_id of the generated component. will use realm_id if not specified.
priority number
Priority of this provider when looking up users. Lower values are first. Defaults to 0. Priority of this provider when looking up users. Lower values are first.
providerId string
The unique ID of the custom provider, specified in the getId implementation for the UserStorageProviderFactory interface. The unique ID of the custom provider, specified in the `getId` implementation for the UserStorageProviderFactory interface
realmId string
The realm that this provider will provide user federation for. The realm (name) this provider will provide user federation for.
realmIdRef object
Reference to a Realm in realm to populate realmId.
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
realmIdSelector object
Selector for a Realm in realm to populate realmId.
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
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
UserFederationStatus defines the observed state of UserFederation.
atProvider object
cachePolicy string
Can be one of DEFAULT, EVICT_DAILY, EVICT_WEEKLY, MAX_LIFESPAN, or NO_CACHE. Defaults to DEFAULT.
changedSyncPeriod number
How frequently Keycloak should sync changed users, in seconds. Omit this property to disable periodic changed users sync. How frequently Keycloak should sync changed users, in seconds. Omit this property to disable periodic changed users sync.
config object
The provider configuration handed over to your custom user federation provider. To give a setting more than one value, join the values with ##; each value is stored separately in Keycloak.
enabled boolean
When false, this provider will not be used when performing queries for users. Defaults to true. When false, this provider will not be used when performing queries for users.
fullSyncPeriod number
How frequently Keycloak should sync all users, in seconds. Omit this property to disable periodic full sync. How frequently Keycloak should sync all users, in seconds. Omit this property to disable periodic full sync.
id string
name string
Display name of the provider when displayed in the console. Display name of the provider when displayed in the console.
parentId string
Must be set to the realms' internal_id when it differs from the realm. This can happen when existing resources are imported into the state. The parent_id of the generated component. will use realm_id if not specified.
priority number
Priority of this provider when looking up users. Lower values are first. Defaults to 0. Priority of this provider when looking up users. Lower values are first.
providerId string
The unique ID of the custom provider, specified in the getId implementation for the UserStorageProviderFactory interface. The unique ID of the custom provider, specified in the `getId` implementation for the UserStorageProviderFactory interface
realmId string
The realm that this provider will provide user federation for. The realm (name) this provider will provide user federation for.
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