{ "description": "FacebookIdentityProvider is the Schema for the FacebookIdentityProviders 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": "FacebookIdentityProviderSpec defines the desired state of FacebookIdentityProvider", "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": { "acceptsPromptNoneForwardFromClient": { "description": "When true, unauthenticated requests with prompt=none will be forwarded to Google instead of returning an error. Defaults to false.\nThis 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.", "type": [ "boolean", "null" ] }, "addReadTokenRoleOnCreate": { "description": "When true, new users will be able to read stored tokens. This will automatically assign the broker.read-token role. Defaults to false.\nEnable/disable if new users can read any stored tokens. This assigns the broker.read-token role.", "type": [ "boolean", "null" ] }, "alias": { "description": "The alias for the Facebook identity provider.\nThe alias uniquely identifies an identity provider and it is also used to build the redirect uri.", "type": [ "string", "null" ] }, "authenticateByDefault": { "description": "Enable/disable authenticate users by default.", "type": [ "boolean", "null" ] }, "clientIdSecretRef": { "additionalProperties": false, "description": "The client or client identifier registered within the identity provider.\nThe client identifier registered with the Facebook identity provider.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the secret.", "type": "string" }, "namespace": { "description": "Namespace of the secret.", "type": "string" } }, "required": [ "key", "name", "namespace" ], "type": [ "object", "null" ] }, "clientSecretSecretRef": { "additionalProperties": false, "description": "The client or client secret registered within the identity provider. This field is able to obtain its value from vault, use $${vault.ID} format.\nThe client secret registered with the Facebook identity provider.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the secret.", "type": "string" }, "namespace": { "description": "Namespace of the secret.", "type": "string" } }, "required": [ "key", "name", "namespace" ], "type": [ "object", "null" ] }, "defaultScopes": { "description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. Defaults to openid profile email.\nThe scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'", "type": [ "string", "null" ] }, "disableUserInfo": { "description": "When true, disables the usage of the user info service to obtain additional user information. Defaults to false.\nDisable usage of User Info service to obtain additional user information? Default is to use this OIDC service.", "type": [ "boolean", "null" ] }, "displayName": { "description": "Display name for the Facebook identity provider in the GUI.\nThe human-friendly name of the identity provider, used in the log in form.", "type": [ "string", "null" ] }, "enabled": { "description": "When true, users will be able to log in to this realm using this identity provider. Defaults to true.\nEnable/disable this identity provider.", "type": [ "boolean", "null" ] }, "extraConfig": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "fetchedFields": { "description": "Provide additional fields which would be fetched using the profile request. This will be appended to the default set of id,name,email,first_name,last_name.\nProvide additional fields which would be fetched using the profile request. This will be appended to the default set of 'id,name,email,first_name,last_name'.", "type": [ "string", "null" ] }, "firstBrokerLoginFlowAlias": { "description": "The authentication flow to use when users log in for the first time through this identity provider. Defaults to first broker login.\nAlias 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.", "type": [ "string", "null" ] }, "firstBrokerLoginFlowAliasRef": { "additionalProperties": false, "description": "Reference to a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.", "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" ] }, "firstBrokerLoginFlowAliasSelector": { "additionalProperties": false, "description": "Selector for a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.", "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" ] }, "guiOrder": { "description": "A number defining the order of this identity provider in the GUI.\nGUI Order", "type": [ "string", "null" ] }, "hideOnLoginPage": { "description": "When true, this identity provider will be hidden on the login page. Defaults to false.\nHide On Login Page.", "type": [ "boolean", "null" ] }, "linkOnly": { "description": "When true, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to false.\nIf 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", "type": [ "boolean", "null" ] }, "orgDomain": { "type": [ "string", "null" ] }, "orgRedirectModeEmailMatches": { "type": [ "boolean", "null" ] }, "organizationId": { "description": "ID of organization with which this identity is linked.", "type": [ "string", "null" ] }, "organizationIdRef": { "additionalProperties": false, "description": "Reference to a Organization in organization to populate organizationId.", "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" ] }, "organizationIdSelector": { "additionalProperties": false, "description": "Selector for a Organization in organization to populate organizationId.", "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" ] }, "postBrokerLoginFlowAlias": { "description": "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.\nAlias 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.", "type": [ "string", "null" ] }, "providerId": { "description": "The ID of the identity provider to use. Defaults to facebook, which should be used unless you have extended Keycloak and provided your own implementation.\nprovider id, is always facebook, unless you have a extended custom implementation", "type": [ "string", "null" ] }, "realm": { "description": "The name of the realm. This is unique across Keycloak.\nRealm Name", "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" ] }, "storeToken": { "description": "When true, tokens will be stored after authenticating users. Defaults to true.\nEnable/disable if tokens must be stored after authenticating users.", "type": [ "boolean", "null" ] }, "syncMode": { "description": "The default sync mode to use for all mappers attached to this identity provider. Can be once of IMPORT, FORCE, or LEGACY.\nSync Mode", "type": [ "string", "null" ] }, "trustEmail": { "description": "When true, email addresses for users in this provider will automatically be verified regardless of the realm's email verification policy. Defaults to false.\nIf enabled then email provided by this provider is not verified even if verification is enabled for the realm.", "type": [ "boolean", "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": { "acceptsPromptNoneForwardFromClient": { "description": "When true, unauthenticated requests with prompt=none will be forwarded to Google instead of returning an error. Defaults to false.\nThis 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.", "type": [ "boolean", "null" ] }, "addReadTokenRoleOnCreate": { "description": "When true, new users will be able to read stored tokens. This will automatically assign the broker.read-token role. Defaults to false.\nEnable/disable if new users can read any stored tokens. This assigns the broker.read-token role.", "type": [ "boolean", "null" ] }, "alias": { "description": "The alias for the Facebook identity provider.\nThe alias uniquely identifies an identity provider and it is also used to build the redirect uri.", "type": [ "string", "null" ] }, "authenticateByDefault": { "description": "Enable/disable authenticate users by default.", "type": [ "boolean", "null" ] }, "clientIdSecretRef": { "additionalProperties": false, "description": "The client or client identifier registered within the identity provider.\nThe client identifier registered with the Facebook identity provider.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the secret.", "type": "string" }, "namespace": { "description": "Namespace of the secret.", "type": "string" } }, "required": [ "key", "name", "namespace" ], "type": "object" }, "clientSecretSecretRef": { "additionalProperties": false, "description": "The client or client secret registered within the identity provider. This field is able to obtain its value from vault, use $${vault.ID} format.\nThe client secret registered with the Facebook identity provider.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the secret.", "type": "string" }, "namespace": { "description": "Namespace of the secret.", "type": "string" } }, "required": [ "key", "name", "namespace" ], "type": "object" }, "defaultScopes": { "description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. Defaults to openid profile email.\nThe scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'", "type": [ "string", "null" ] }, "disableUserInfo": { "description": "When true, disables the usage of the user info service to obtain additional user information. Defaults to false.\nDisable usage of User Info service to obtain additional user information? Default is to use this OIDC service.", "type": [ "boolean", "null" ] }, "displayName": { "description": "Display name for the Facebook identity provider in the GUI.\nThe human-friendly name of the identity provider, used in the log in form.", "type": [ "string", "null" ] }, "enabled": { "description": "When true, users will be able to log in to this realm using this identity provider. Defaults to true.\nEnable/disable this identity provider.", "type": [ "boolean", "null" ] }, "extraConfig": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "fetchedFields": { "description": "Provide additional fields which would be fetched using the profile request. This will be appended to the default set of id,name,email,first_name,last_name.\nProvide additional fields which would be fetched using the profile request. This will be appended to the default set of 'id,name,email,first_name,last_name'.", "type": [ "string", "null" ] }, "firstBrokerLoginFlowAlias": { "description": "The authentication flow to use when users log in for the first time through this identity provider. Defaults to first broker login.\nAlias 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.", "type": [ "string", "null" ] }, "firstBrokerLoginFlowAliasRef": { "additionalProperties": false, "description": "Reference to a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.", "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" ] }, "firstBrokerLoginFlowAliasSelector": { "additionalProperties": false, "description": "Selector for a Flow in authenticationflow to populate firstBrokerLoginFlowAlias.", "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" ] }, "guiOrder": { "description": "A number defining the order of this identity provider in the GUI.\nGUI Order", "type": [ "string", "null" ] }, "hideOnLoginPage": { "description": "When true, this identity provider will be hidden on the login page. Defaults to false.\nHide On Login Page.", "type": [ "boolean", "null" ] }, "linkOnly": { "description": "When true, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to false.\nIf 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", "type": [ "boolean", "null" ] }, "orgDomain": { "type": [ "string", "null" ] }, "orgRedirectModeEmailMatches": { "type": [ "boolean", "null" ] }, "organizationId": { "description": "ID of organization with which this identity is linked.", "type": [ "string", "null" ] }, "organizationIdRef": { "additionalProperties": false, "description": "Reference to a Organization in organization to populate organizationId.", "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" ] }, "organizationIdSelector": { "additionalProperties": false, "description": "Selector for a Organization in organization to populate organizationId.", "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" ] }, "postBrokerLoginFlowAlias": { "description": "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.\nAlias 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.", "type": [ "string", "null" ] }, "providerId": { "description": "The ID of the identity provider to use. Defaults to facebook, which should be used unless you have extended Keycloak and provided your own implementation.\nprovider id, is always facebook, unless you have a extended custom implementation", "type": [ "string", "null" ] }, "realm": { "description": "The name of the realm. This is unique across Keycloak.\nRealm Name", "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" ] }, "storeToken": { "description": "When true, tokens will be stored after authenticating users. Defaults to true.\nEnable/disable if tokens must be stored after authenticating users.", "type": [ "boolean", "null" ] }, "syncMode": { "description": "The default sync mode to use for all mappers attached to this identity provider. Can be once of IMPORT, FORCE, or LEGACY.\nSync Mode", "type": [ "string", "null" ] }, "trustEmail": { "description": "When true, email addresses for users in this provider will automatically be verified regardless of the realm's email verification policy. Defaults to false.\nIf enabled then email provided by this provider is not verified even if verification is enabled for the realm.", "type": [ "boolean", "null" ] } }, "required": [ "clientIdSecretRef", "clientSecretSecretRef" ], "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.clientIdSecretRef is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.clientIdSecretRef)" }, { "message": "spec.forProvider.clientSecretSecretRef is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.clientSecretSecretRef)" } ] }, "status": { "additionalProperties": false, "description": "FacebookIdentityProviderStatus defines the observed state of FacebookIdentityProvider.", "properties": { "atProvider": { "additionalProperties": false, "properties": { "acceptsPromptNoneForwardFromClient": { "description": "When true, unauthenticated requests with prompt=none will be forwarded to Google instead of returning an error. Defaults to false.\nThis 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.", "type": [ "boolean", "null" ] }, "addReadTokenRoleOnCreate": { "description": "When true, new users will be able to read stored tokens. This will automatically assign the broker.read-token role. Defaults to false.\nEnable/disable if new users can read any stored tokens. This assigns the broker.read-token role.", "type": [ "boolean", "null" ] }, "alias": { "description": "The alias for the Facebook identity provider.\nThe alias uniquely identifies an identity provider and it is also used to build the redirect uri.", "type": [ "string", "null" ] }, "authenticateByDefault": { "description": "Enable/disable authenticate users by default.", "type": [ "boolean", "null" ] }, "defaultScopes": { "description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. Defaults to openid profile email.\nThe scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'", "type": [ "string", "null" ] }, "disableUserInfo": { "description": "When true, disables the usage of the user info service to obtain additional user information. Defaults to false.\nDisable usage of User Info service to obtain additional user information? Default is to use this OIDC service.", "type": [ "boolean", "null" ] }, "displayName": { "description": "Display name for the Facebook identity provider in the GUI.\nThe human-friendly name of the identity provider, used in the log in form.", "type": [ "string", "null" ] }, "enabled": { "description": "When true, users will be able to log in to this realm using this identity provider. Defaults to true.\nEnable/disable this identity provider.", "type": [ "boolean", "null" ] }, "extraConfig": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "fetchedFields": { "description": "Provide additional fields which would be fetched using the profile request. This will be appended to the default set of id,name,email,first_name,last_name.\nProvide additional fields which would be fetched using the profile request. This will be appended to the default set of 'id,name,email,first_name,last_name'.", "type": [ "string", "null" ] }, "firstBrokerLoginFlowAlias": { "description": "The authentication flow to use when users log in for the first time through this identity provider. Defaults to first broker login.\nAlias 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.", "type": [ "string", "null" ] }, "guiOrder": { "description": "A number defining the order of this identity provider in the GUI.\nGUI Order", "type": [ "string", "null" ] }, "hideOnLoginPage": { "description": "When true, this identity provider will be hidden on the login page. Defaults to false.\nHide On Login Page.", "type": [ "boolean", "null" ] }, "id": { "type": [ "string", "null" ] }, "internalId": { "description": "(Computed) The unique ID that Keycloak assigns to the identity provider upon creation.\nInternal Identity Provider Id", "type": [ "string", "null" ] }, "linkOnly": { "description": "When true, users cannot sign-in using this provider, but their existing accounts will be linked when possible. Defaults to false.\nIf 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", "type": [ "boolean", "null" ] }, "orgDomain": { "type": [ "string", "null" ] }, "orgRedirectModeEmailMatches": { "type": [ "boolean", "null" ] }, "organizationId": { "description": "ID of organization with which this identity is linked.", "type": [ "string", "null" ] }, "postBrokerLoginFlowAlias": { "description": "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.\nAlias 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.", "type": [ "string", "null" ] }, "providerId": { "description": "The ID of the identity provider to use. Defaults to facebook, which should be used unless you have extended Keycloak and provided your own implementation.\nprovider id, is always facebook, unless you have a extended custom implementation", "type": [ "string", "null" ] }, "realm": { "description": "The name of the realm. This is unique across Keycloak.\nRealm Name", "type": [ "string", "null" ] }, "storeToken": { "description": "When true, tokens will be stored after authenticating users. Defaults to true.\nEnable/disable if tokens must be stored after authenticating users.", "type": [ "boolean", "null" ] }, "syncMode": { "description": "The default sync mode to use for all mappers attached to this identity provider. Can be once of IMPORT, FORCE, or LEGACY.\nSync Mode", "type": [ "string", "null" ] }, "trustEmail": { "description": "When true, email addresses for users in this provider will automatically be verified regardless of the realm's email verification policy. Defaults to false.\nIf enabled then email provided by this provider is not verified even if verification is enabled for the realm.", "type": [ "boolean", "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" }