Skip to search

UserRealmRoleProtocolMapper

openidgroup.keycloak.crossplane.io / v1alpha1

apiVersion: openidgroup.keycloak.crossplane.io/v1alpha1 kind: UserRealmRoleProtocolMapper 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
UserRealmRoleProtocolMapperSpec defines the desired state of UserRealmRoleProtocolMapper
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
addToAccessToken boolean
Indicates if the property should be added as a claim to the access token. Defaults to true. Indicates if the attribute should be a claim in the access token.
addToIdToken boolean
Indicates if the property should be added as a claim to the id token. Defaults to true. Indicates if the attribute should be a claim in the id token.
addToTokenIntrospection boolean
Indicates if the property should be added as a claim to the Token Introspection response body. Defaults to true. Indicates if the attribute should be a claim in the token introspection response body.
addToUserinfo boolean
Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true. Indicates if the attribute should appear in the userinfo response body.
claimName string
The name of the claim to insert into a token.
claimValueType string
The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String. Claim type used when serializing tokens.
clientId string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified. The mapper's associated client. Cannot be used at the same time as client_scope_id.
clientIdRef object
Reference to a Client in openidclient to populate clientId.
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
clientIdSelector object
Selector for a Client in openidclient to populate clientId.
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
clientScopeId string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. The mapper's associated client scope. Cannot be used at the same time as client_id.
clientScopeIdRef object
Reference to a ClientScope in openidclient to populate clientScopeId.
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
clientScopeIdSelector object
Selector for a ClientScope in openidclient to populate clientScopeId.
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
multivalued boolean
Indicates if attribute supports multiple values. If true, then the list of all values of this attribute will be set as claim. If false, then just first value will be set as claim. Defaults to false. Indicates whether this attribute is a single value or an array of values.
name string
The display name of this protocol mapper in the GUI. A human-friendly name that will appear in the Keycloak console.
realmId string
The realm this protocol mapper exists within. The realm id where the associated client or client scope exists.
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
realmRolePrefix string
A prefix for each Realm Role. Prefix that will be added to each realm role.
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.
addToAccessToken boolean
Indicates if the property should be added as a claim to the access token. Defaults to true. Indicates if the attribute should be a claim in the access token.
addToIdToken boolean
Indicates if the property should be added as a claim to the id token. Defaults to true. Indicates if the attribute should be a claim in the id token.
addToTokenIntrospection boolean
Indicates if the property should be added as a claim to the Token Introspection response body. Defaults to true. Indicates if the attribute should be a claim in the token introspection response body.
addToUserinfo boolean
Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true. Indicates if the attribute should appear in the userinfo response body.
claimName string
The name of the claim to insert into a token.
claimValueType string
The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String. Claim type used when serializing tokens.
clientId string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified. The mapper's associated client. Cannot be used at the same time as client_scope_id.
clientIdRef object
Reference to a Client in openidclient to populate clientId.
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
clientIdSelector object
Selector for a Client in openidclient to populate clientId.
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
clientScopeId string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. The mapper's associated client scope. Cannot be used at the same time as client_id.
clientScopeIdRef object
Reference to a ClientScope in openidclient to populate clientScopeId.
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
clientScopeIdSelector object
Selector for a ClientScope in openidclient to populate clientScopeId.
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
multivalued boolean
Indicates if attribute supports multiple values. If true, then the list of all values of this attribute will be set as claim. If false, then just first value will be set as claim. Defaults to false. Indicates whether this attribute is a single value or an array of values.
name string
The display name of this protocol mapper in the GUI. A human-friendly name that will appear in the Keycloak console.
realmId string
The realm this protocol mapper exists within. The realm id where the associated client or client scope exists.
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
realmRolePrefix string
A prefix for each Realm Role. Prefix that will be added to each realm role.
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
UserRealmRoleProtocolMapperStatus defines the observed state of UserRealmRoleProtocolMapper.
atProvider object
addToAccessToken boolean
Indicates if the property should be added as a claim to the access token. Defaults to true. Indicates if the attribute should be a claim in the access token.
addToIdToken boolean
Indicates if the property should be added as a claim to the id token. Defaults to true. Indicates if the attribute should be a claim in the id token.
addToTokenIntrospection boolean
Indicates if the property should be added as a claim to the Token Introspection response body. Defaults to true. Indicates if the attribute should be a claim in the token introspection response body.
addToUserinfo boolean
Indicates if the property should be added as a claim to the UserInfo response body. Defaults to true. Indicates if the attribute should appear in the userinfo response body.
claimName string
The name of the claim to insert into a token.
claimValueType string
The claim type used when serializing JSON tokens. Can be one of String, JSON, long, int, or boolean. Defaults to String. Claim type used when serializing tokens.
clientId string
The client this protocol mapper should be attached to. Conflicts with client_scope_id. One of client_id or client_scope_id must be specified. The mapper's associated client. Cannot be used at the same time as client_scope_id.
clientScopeId string
The client scope this protocol mapper should be attached to. Conflicts with client_id. One of client_id or client_scope_id must be specified. The mapper's associated client scope. Cannot be used at the same time as client_id.
id string
multivalued boolean
Indicates if attribute supports multiple values. If true, then the list of all values of this attribute will be set as claim. If false, then just first value will be set as claim. Defaults to false. Indicates whether this attribute is a single value or an array of values.
name string
The display name of this protocol mapper in the GUI. A human-friendly name that will appear in the Keycloak console.
realmId string
The realm this protocol mapper exists within. The realm id where the associated client or client scope exists.
realmRolePrefix string
A prefix for each Realm Role. Prefix that will be added to each realm role.
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