Skip to search

MicrosoftIdentityProvider

oidc.keycloak.m.crossplane.io / v1alpha1

apiVersion: oidc.keycloak.m.crossplane.io/v1alpha1 kind: MicrosoftIdentityProvider 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
MicrosoftIdentityProviderSpec defines the desired state of MicrosoftIdentityProvider
forProvider object required
acceptsPromptNoneForwardFromClient boolean
When true, unauthenticated requests with prompt=none will be forwarded to Microsoft instead of returning an error. Defaults to false. This is just used together with Identity Provider Authenticator or when kc_idp_hint points to this identity provider. In case that client sends a request with prompt=none and user is not yet authenticated, the error will not be directly returned to client, but the request with prompt=none will be forwarded to this identity provider.
addReadTokenRoleOnCreate boolean
When true, new users will be able to read stored tokens. This will automatically assign the broker.read-token role. Defaults to false. Enable/disable if new users can read any stored tokens. This assigns the broker.read-token role.
alias string
The alias for the Microsoft identity provider. The alias uniquely identifies an identity provider and is also used to build the redirect URI. Defaults to microsoft.
authenticateByDefault boolean
Enable/disable authenticate users by default.
clientIdSecretRef object
The client or client identifier registered within the identity provider. Client ID.
key string required
name string required
Name of the secret.
clientSecretSecretRef object
The client or client secret registered within the identity provider. This field is able to obtain its value from vault, use $${vault.ID} format. Client Secret.
key string required
name string required
Name of the secret.
defaultScopes string
The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. Defaults to openid profile email. The scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'
disableUserInfo boolean
When true, disables the usage of the user info service to obtain additional user information. Defaults to false. Disable usage of User Info service to obtain additional user information? Default is to use this OIDC service.
displayName string
Display name for the Microsoft identity provider in the GUI. The human-friendly name of the identity provider, used in the log in form.
enabled boolean
When true, users will be able to log in to this realm using this identity provider. Defaults to true. Enable/disable this identity provider.
extraConfig object
A map of key/value pairs to add extra configuration to this identity provider. Use this attribute at your own risk, as custom attributes may conflict with top-level configuration attributes in future provider updates.
firstBrokerLoginFlowAlias string
The authentication flow to use when users log in for the first time through this identity provider. Defaults to first broker login. Alias of authentication flow, which is triggered after first login with this identity provider. Term 'First Login' means that there is not yet existing Keycloak account linked with the authenticated identity provider account.
firstBrokerLoginFlowAliasRef object
Reference to a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.
name string required
Name of the referenced object.
namespace string
Namespace 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
firstBrokerLoginFlowAliasSelector object
Selector for a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.
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.
namespace string
Namespace for the selector
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
guiOrder string
A number defining the order of this identity provider in the GUI. GUI Order
hideOnLoginPage boolean
When true, this identity provider will be hidden on the login page. Defaults to false. Hide On Login Page.
linkOnly boolean
When true, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to false. If true, users cannot log in through this provider. They can only link to this provider. This is useful if you don't want to allow login from the provider, but want to integrate with a provider
orgDomain string
orgRedirectModeEmailMatches boolean
organizationId string
ID of organization with which this identity is linked.
organizationIdRef object
Reference to a Organization in organization to populate organizationId.
name string required
Name of the referenced object.
namespace string
Namespace 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
organizationIdSelector object
Selector for a Organization in organization to populate organizationId.
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.
namespace string
Namespace for the selector
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
postBrokerLoginFlowAlias string
The authentication flow to use after users have successfully logged in, which can be used to perform additional user verification (such as OTP checking). Defaults to an empty string, which means no post login flow will be used. Alias of authentication flow, which is triggered after each login with this identity provider. Useful if you want additional verification of each user authenticated with this identity provider (for example OTP). Leave this empty if you don't want any additional authenticators to be triggered after login with this identity provider. Also note, that authenticator implementations must assume that user is already set in ClientSession as identity provider already set it.
prompt string
Indicates the type of user interaction that is required. The only valid values at this time are login, none, consent, and select_account. Prompt parameter for Microsoft identity provider. Available options are 'login', 'none', 'consent' and 'select_account'.
providerId string
The ID of the identity provider to use. Defaults to microsoft, which should be used unless you have extended Keycloak and provided your own implementation. Provider ID, is always microsoft.
realm string
The name of the realm. This is unique across Keycloak. Realm Name
realmRef object
Reference to a Realm in realm to populate realm.
name string required
Name of the referenced object.
namespace string
Namespace 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.
namespace string
Namespace for the selector
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
storeToken boolean
When true, tokens will be stored after authenticating users. Defaults to true. Enable/disable if tokens must be stored after authenticating users.
syncMode string
The default sync mode to use for all mappers attached to this identity provider. Can be one of IMPORT, FORCE, or LEGACY. Sync Mode
tenantId string
Uses single-tenant auth endpoints when specified, uses common' multi-tenant endpoints otherwise. Tenant ID.
trustEmail boolean
When true, email addresses for users in this provider will automatically be verified regardless of the realm's email verification policy. Defaults to false. If enabled then email provided by this provider is not verified even if verification is enabled for the realm.
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.
acceptsPromptNoneForwardFromClient boolean
When true, unauthenticated requests with prompt=none will be forwarded to Microsoft instead of returning an error. Defaults to false. This is just used together with Identity Provider Authenticator or when kc_idp_hint points to this identity provider. In case that client sends a request with prompt=none and user is not yet authenticated, the error will not be directly returned to client, but the request with prompt=none will be forwarded to this identity provider.
addReadTokenRoleOnCreate boolean
When true, new users will be able to read stored tokens. This will automatically assign the broker.read-token role. Defaults to false. Enable/disable if new users can read any stored tokens. This assigns the broker.read-token role.
alias string
The alias for the Microsoft identity provider. The alias uniquely identifies an identity provider and is also used to build the redirect URI. Defaults to microsoft.
authenticateByDefault boolean
Enable/disable authenticate users by default.
clientIdSecretRef object required
The client or client identifier registered within the identity provider. Client ID.
key string required
name string required
Name of the secret.
clientSecretSecretRef object required
The client or client secret registered within the identity provider. This field is able to obtain its value from vault, use $${vault.ID} format. Client Secret.
key string required
name string required
Name of the secret.
defaultScopes string
The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. Defaults to openid profile email. The scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'
disableUserInfo boolean
When true, disables the usage of the user info service to obtain additional user information. Defaults to false. Disable usage of User Info service to obtain additional user information? Default is to use this OIDC service.
displayName string
Display name for the Microsoft identity provider in the GUI. The human-friendly name of the identity provider, used in the log in form.
enabled boolean
When true, users will be able to log in to this realm using this identity provider. Defaults to true. Enable/disable this identity provider.
extraConfig object
A map of key/value pairs to add extra configuration to this identity provider. Use this attribute at your own risk, as custom attributes may conflict with top-level configuration attributes in future provider updates.
firstBrokerLoginFlowAlias string
The authentication flow to use when users log in for the first time through this identity provider. Defaults to first broker login. Alias of authentication flow, which is triggered after first login with this identity provider. Term 'First Login' means that there is not yet existing Keycloak account linked with the authenticated identity provider account.
firstBrokerLoginFlowAliasRef object
Reference to a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.
name string required
Name of the referenced object.
namespace string
Namespace 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
firstBrokerLoginFlowAliasSelector object
Selector for a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.
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.
namespace string
Namespace for the selector
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
guiOrder string
A number defining the order of this identity provider in the GUI. GUI Order
hideOnLoginPage boolean
When true, this identity provider will be hidden on the login page. Defaults to false. Hide On Login Page.
linkOnly boolean
When true, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to false. If true, users cannot log in through this provider. They can only link to this provider. This is useful if you don't want to allow login from the provider, but want to integrate with a provider
orgDomain string
orgRedirectModeEmailMatches boolean
organizationId string
ID of organization with which this identity is linked.
organizationIdRef object
Reference to a Organization in organization to populate organizationId.
name string required
Name of the referenced object.
namespace string
Namespace 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
organizationIdSelector object
Selector for a Organization in organization to populate organizationId.
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.
namespace string
Namespace for the selector
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
postBrokerLoginFlowAlias string
The authentication flow to use after users have successfully logged in, which can be used to perform additional user verification (such as OTP checking). Defaults to an empty string, which means no post login flow will be used. Alias of authentication flow, which is triggered after each login with this identity provider. Useful if you want additional verification of each user authenticated with this identity provider (for example OTP). Leave this empty if you don't want any additional authenticators to be triggered after login with this identity provider. Also note, that authenticator implementations must assume that user is already set in ClientSession as identity provider already set it.
prompt string
Indicates the type of user interaction that is required. The only valid values at this time are login, none, consent, and select_account. Prompt parameter for Microsoft identity provider. Available options are 'login', 'none', 'consent' and 'select_account'.
providerId string
The ID of the identity provider to use. Defaults to microsoft, which should be used unless you have extended Keycloak and provided your own implementation. Provider ID, is always microsoft.
realm string
The name of the realm. This is unique across Keycloak. Realm Name
realmRef object
Reference to a Realm in realm to populate realm.
name string required
Name of the referenced object.
namespace string
Namespace 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.
namespace string
Namespace for the selector
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
storeToken boolean
When true, tokens will be stored after authenticating users. Defaults to true. Enable/disable if tokens must be stored after authenticating users.
syncMode string
The default sync mode to use for all mappers attached to this identity provider. Can be one of IMPORT, FORCE, or LEGACY. Sync Mode
tenantId string
Uses single-tenant auth endpoints when specified, uses common' multi-tenant endpoints otherwise. Tenant ID.
trustEmail boolean
When true, email addresses for users in this provider will automatically be verified regardless of the realm's email verification policy. Defaults to false. If enabled then email provided by this provider is not verified even if verification is enabled for the realm.
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. 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.
kind string required
Kind of the referenced object.
name string required
Name of the referenced object.
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.
status object
MicrosoftIdentityProviderStatus defines the observed state of MicrosoftIdentityProvider.
atProvider object
acceptsPromptNoneForwardFromClient boolean
When true, unauthenticated requests with prompt=none will be forwarded to Microsoft instead of returning an error. Defaults to false. This is just used together with Identity Provider Authenticator or when kc_idp_hint points to this identity provider. In case that client sends a request with prompt=none and user is not yet authenticated, the error will not be directly returned to client, but the request with prompt=none will be forwarded to this identity provider.
addReadTokenRoleOnCreate boolean
When true, new users will be able to read stored tokens. This will automatically assign the broker.read-token role. Defaults to false. Enable/disable if new users can read any stored tokens. This assigns the broker.read-token role.
alias string
The alias for the Microsoft identity provider. The alias uniquely identifies an identity provider and is also used to build the redirect URI. Defaults to microsoft.
authenticateByDefault boolean
Enable/disable authenticate users by default.
defaultScopes string
The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. Defaults to openid profile email. The scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'
disableUserInfo boolean
When true, disables the usage of the user info service to obtain additional user information. Defaults to false. Disable usage of User Info service to obtain additional user information? Default is to use this OIDC service.
displayName string
Display name for the Microsoft identity provider in the GUI. The human-friendly name of the identity provider, used in the log in form.
enabled boolean
When true, users will be able to log in to this realm using this identity provider. Defaults to true. Enable/disable this identity provider.
extraConfig object
A map of key/value pairs to add extra configuration to this identity provider. Use this attribute at your own risk, as custom attributes may conflict with top-level configuration attributes in future provider updates.
firstBrokerLoginFlowAlias string
The authentication flow to use when users log in for the first time through this identity provider. Defaults to first broker login. Alias of authentication flow, which is triggered after first login with this identity provider. Term 'First Login' means that there is not yet existing Keycloak account linked with the authenticated identity provider account.
guiOrder string
A number defining the order of this identity provider in the GUI. GUI Order
hideOnLoginPage boolean
When true, this identity provider will be hidden on the login page. Defaults to false. Hide On Login Page.
id string
internalId string
(Computed) The unique ID that Keycloak assigns to the identity provider upon creation. Internal Identity Provider Id
linkOnly boolean
When true, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to false. If true, users cannot log in through this provider. They can only link to this provider. This is useful if you don't want to allow login from the provider, but want to integrate with a provider
orgDomain string
orgRedirectModeEmailMatches boolean
organizationId string
ID of organization with which this identity is linked.
postBrokerLoginFlowAlias string
The authentication flow to use after users have successfully logged in, which can be used to perform additional user verification (such as OTP checking). Defaults to an empty string, which means no post login flow will be used. Alias of authentication flow, which is triggered after each login with this identity provider. Useful if you want additional verification of each user authenticated with this identity provider (for example OTP). Leave this empty if you don't want any additional authenticators to be triggered after login with this identity provider. Also note, that authenticator implementations must assume that user is already set in ClientSession as identity provider already set it.
prompt string
Indicates the type of user interaction that is required. The only valid values at this time are login, none, consent, and select_account. Prompt parameter for Microsoft identity provider. Available options are 'login', 'none', 'consent' and 'select_account'.
providerId string
The ID of the identity provider to use. Defaults to microsoft, which should be used unless you have extended Keycloak and provided your own implementation. Provider ID, is always microsoft.
realm string
The name of the realm. This is unique across Keycloak. Realm Name
storeToken boolean
When true, tokens will be stored after authenticating users. Defaults to true. Enable/disable if tokens must be stored after authenticating users.
syncMode string
The default sync mode to use for all mappers attached to this identity provider. Can be one of IMPORT, FORCE, or LEGACY. Sync Mode
tenantId string
Uses single-tenant auth endpoints when specified, uses common' multi-tenant endpoints otherwise. Tenant ID.
trustEmail boolean
When true, email addresses for users in this provider will automatically be verified regardless of the realm's email verification policy. Defaults to false. If enabled then email provided by this provider is not verified even if verification is enabled for the realm.
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.forProvider for an exact path