{ "description": "Client is the Schema for the Clients 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": "ClientSpec defines the desired state of Client", "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": { "alwaysDisplayInConsole": { "description": "Always list this client in the Account UI, even if the user does not have an active session.", "type": [ "boolean", "null" ] }, "assertionConsumerPostUrl": { "description": "SAML POST Binding URL for the client's assertion consumer service (login responses).", "type": [ "string", "null" ] }, "assertionConsumerRedirectUrl": { "description": "SAML Redirect Binding URL for the client's assertion consumer service (login responses).", "type": [ "string", "null" ] }, "authenticationFlowBindingOverrides": { "description": "Override realm authentication flow bindings", "items": { "additionalProperties": false, "properties": { "browserId": { "description": "Browser flow id, (flow needs to exist)", "type": [ "string", "null" ] }, "directGrantId": { "description": "Direct grant flow id (flow needs to exist)", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "baseUrl": { "description": "When specified, this URL will be used whenever Keycloak needs to link to this client.", "type": [ "string", "null" ] }, "canonicalizationMethod": { "description": "The Canonicalization Method for XML signatures. Should be one of \"EXCLUSIVE\", \"EXCLUSIVE_WITH_COMMENTS\", \"INCLUSIVE\", or \"INCLUSIVE_WITH_COMMENTS\". Defaults to \"EXCLUSIVE\".", "type": [ "string", "null" ] }, "clientId": { "description": "The unique ID of this client, referenced in the URI during authentication and in issued tokens.", "type": [ "string", "null" ] }, "clientSignatureRequired": { "description": "When true, Keycloak will expect that documents originating from a client will be signed using the certificate and/or key configured via signing_certificate and signing_private_key. Defaults to true.", "type": [ "boolean", "null" ] }, "consentRequired": { "description": "When true, users have to consent to client access. Defaults to false.", "type": [ "boolean", "null" ] }, "description": { "description": "The description of this client in the GUI.", "type": [ "string", "null" ] }, "enabled": { "description": "When false, this client will not be able to initiate a login or obtain access tokens. Defaults to true.", "type": [ "boolean", "null" ] }, "encryptAssertions": { "description": "When true, the SAML assertions will be encrypted by Keycloak using the client's public key. Defaults to false.", "type": [ "boolean", "null" ] }, "encryptionAlgorithm": { "description": "Algorithm used to encrypt SAML assertions. Allowed values: AES_256_GCM, AES_192_GCM, AES_128_GCM, AES_256_CBC, AES_192_CBC, or AES_128_CBC.", "type": [ "string", "null" ] }, "encryptionCertificateSecretRef": { "additionalProperties": false, "description": "If assertions for the client are encrypted, this certificate will be used for encryption.", "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" ] }, "encryptionDigestMethod": { "description": "Digest method used with SAML encryption. Allowed values: SHA-512, SHA-256, or SHA-1. Only valid when encryption_key_algorithm is RSA-OAEP-11 or RSA-OAEP-MGF1P. Default is SHA-256.", "type": [ "string", "null" ] }, "encryptionKeyAlgorithm": { "description": "Key transport algorithm used by the client to encrypt the secret key for SAML assertion encryption. Allowed values: RSA-OAEP-11, RSA-OAEP-MGF1P, or RSA1_5. Default is RSA-OAEP-11.", "type": [ "string", "null" ] }, "encryptionMaskGenerationFunction": { "description": "Mask generation function used with SAML encryption. Allowed values: mgf1sha1, mgf1sha224, mgf1sha256, mgf1sha384, or mgf1sha512. Only valid when encryption_key_algorithm is RSA-OAEP-11. Default is mgf1sha256.", "type": [ "string", "null" ] }, "extraConfig": { "additionalProperties": { "type": "string" }, "description": "A map of key/value pairs to add extra configuration attributes to this client. Use this attribute at your own risk, as s may conflict with top-level configuration attributes in future provider updates.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "forceNameIdFormat": { "description": "Ignore requested NameID subject format and use the one defined in name_id_format instead. Defaults to false.", "type": [ "boolean", "null" ] }, "forcePostBinding": { "description": "When true, Keycloak will always respond to an authentication request via the SAML POST Binding. Defaults to true.", "type": [ "boolean", "null" ] }, "frontChannelLogout": { "description": "When true, this client will require a browser redirect in order to perform a logout. Defaults to true.", "type": [ "boolean", "null" ] }, "fullScopeAllowed": { "description": "- Allow to include all roles mappings in the access token", "type": [ "boolean", "null" ] }, "idpInitiatedSsoRelayState": { "description": "Relay state you want to send with SAML request when you want to do IDP Initiated SSO.", "type": [ "string", "null" ] }, "idpInitiatedSsoUrlName": { "description": "URL fragment name to reference client when you want to do IDP Initiated SSO.", "type": [ "string", "null" ] }, "includeAuthnStatement": { "description": "When true, an AuthnStatement will be included in the SAML response. Defaults to true.", "type": [ "boolean", "null" ] }, "loginTheme": { "description": "The login theme of this client.", "type": [ "string", "null" ] }, "logoutServicePostBindingUrl": { "description": "SAML POST Binding URL for the client's single logout service.", "type": [ "string", "null" ] }, "logoutServiceRedirectBindingUrl": { "description": "SAML Redirect Binding URL for the client's single logout service.", "type": [ "string", "null" ] }, "masterSamlProcessingUrl": { "description": "When specified, this URL will be used for all SAML requests.", "type": [ "string", "null" ] }, "name": { "description": "The display name of this client in the GUI.", "type": [ "string", "null" ] }, "nameIdFormat": { "description": "Sets the Name ID format for the subject.", "type": [ "string", "null" ] }, "realmId": { "description": "The realm this client is attached to.", "type": [ "string", "null" ] }, "realmIdRef": { "additionalProperties": false, "description": "Reference to a Realm in realm to populate realmId.", "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" ] }, "realmIdSelector": { "additionalProperties": false, "description": "Selector for a Realm in realm to populate realmId.", "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" ] }, "rootUrl": { "description": "When specified, this value is prepended to all relative URLs.", "type": [ "string", "null" ] }, "signAssertions": { "description": "When true, the SAML assertions will be signed by Keycloak using the realm's private key, and embedded within the SAML XML Auth response. Defaults to false.", "type": [ "boolean", "null" ] }, "signDocuments": { "description": "When true, the SAML document will be signed by Keycloak using the realm's private key. Defaults to true.", "type": [ "boolean", "null" ] }, "signatureAlgorithm": { "description": "The signature algorithm used to sign documents. Should be one of \"RSA_SHA1\", \"RSA_SHA256\", \"RSA_SHA256_MGF1, \"RSA_SHA512\", \"RSA_SHA512_MGF1\" or \"DSA_SHA1\".", "type": [ "string", "null" ] }, "signatureKeyName": { "description": "The value of the KeyName element within the signed SAML document. Should be one of \"NONE\", \"KEY_ID\", or \"CERT_SUBJECT\". Defaults to \"KEY_ID\".", "type": [ "string", "null" ] }, "signingCertificateSecretRef": { "additionalProperties": false, "description": "If documents or assertions from the client are signed, this certificate will be used to verify the signature.", "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" ] }, "signingPrivateKeySecretRef": { "additionalProperties": false, "description": "If documents or assertions from the client are signed, this private key will be used to verify the signature.", "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" ] }, "validRedirectUris": { "description": "When specified, Keycloak will use this list to validate given Assertion Consumer URLs specified in the authentication request.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" } }, "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": { "alwaysDisplayInConsole": { "description": "Always list this client in the Account UI, even if the user does not have an active session.", "type": [ "boolean", "null" ] }, "assertionConsumerPostUrl": { "description": "SAML POST Binding URL for the client's assertion consumer service (login responses).", "type": [ "string", "null" ] }, "assertionConsumerRedirectUrl": { "description": "SAML Redirect Binding URL for the client's assertion consumer service (login responses).", "type": [ "string", "null" ] }, "authenticationFlowBindingOverrides": { "description": "Override realm authentication flow bindings", "items": { "additionalProperties": false, "properties": { "browserId": { "description": "Browser flow id, (flow needs to exist)", "type": [ "string", "null" ] }, "directGrantId": { "description": "Direct grant flow id (flow needs to exist)", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "baseUrl": { "description": "When specified, this URL will be used whenever Keycloak needs to link to this client.", "type": [ "string", "null" ] }, "canonicalizationMethod": { "description": "The Canonicalization Method for XML signatures. Should be one of \"EXCLUSIVE\", \"EXCLUSIVE_WITH_COMMENTS\", \"INCLUSIVE\", or \"INCLUSIVE_WITH_COMMENTS\". Defaults to \"EXCLUSIVE\".", "type": [ "string", "null" ] }, "clientId": { "description": "The unique ID of this client, referenced in the URI during authentication and in issued tokens.", "type": [ "string", "null" ] }, "clientSignatureRequired": { "description": "When true, Keycloak will expect that documents originating from a client will be signed using the certificate and/or key configured via signing_certificate and signing_private_key. Defaults to true.", "type": [ "boolean", "null" ] }, "consentRequired": { "description": "When true, users have to consent to client access. Defaults to false.", "type": [ "boolean", "null" ] }, "description": { "description": "The description of this client in the GUI.", "type": [ "string", "null" ] }, "enabled": { "description": "When false, this client will not be able to initiate a login or obtain access tokens. Defaults to true.", "type": [ "boolean", "null" ] }, "encryptAssertions": { "description": "When true, the SAML assertions will be encrypted by Keycloak using the client's public key. Defaults to false.", "type": [ "boolean", "null" ] }, "encryptionAlgorithm": { "description": "Algorithm used to encrypt SAML assertions. Allowed values: AES_256_GCM, AES_192_GCM, AES_128_GCM, AES_256_CBC, AES_192_CBC, or AES_128_CBC.", "type": [ "string", "null" ] }, "encryptionCertificateSecretRef": { "additionalProperties": false, "description": "If assertions for the client are encrypted, this certificate will be used for encryption.", "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" ] }, "encryptionDigestMethod": { "description": "Digest method used with SAML encryption. Allowed values: SHA-512, SHA-256, or SHA-1. Only valid when encryption_key_algorithm is RSA-OAEP-11 or RSA-OAEP-MGF1P. Default is SHA-256.", "type": [ "string", "null" ] }, "encryptionKeyAlgorithm": { "description": "Key transport algorithm used by the client to encrypt the secret key for SAML assertion encryption. Allowed values: RSA-OAEP-11, RSA-OAEP-MGF1P, or RSA1_5. Default is RSA-OAEP-11.", "type": [ "string", "null" ] }, "encryptionMaskGenerationFunction": { "description": "Mask generation function used with SAML encryption. Allowed values: mgf1sha1, mgf1sha224, mgf1sha256, mgf1sha384, or mgf1sha512. Only valid when encryption_key_algorithm is RSA-OAEP-11. Default is mgf1sha256.", "type": [ "string", "null" ] }, "extraConfig": { "additionalProperties": { "type": "string" }, "description": "A map of key/value pairs to add extra configuration attributes to this client. Use this attribute at your own risk, as s may conflict with top-level configuration attributes in future provider updates.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "forceNameIdFormat": { "description": "Ignore requested NameID subject format and use the one defined in name_id_format instead. Defaults to false.", "type": [ "boolean", "null" ] }, "forcePostBinding": { "description": "When true, Keycloak will always respond to an authentication request via the SAML POST Binding. Defaults to true.", "type": [ "boolean", "null" ] }, "frontChannelLogout": { "description": "When true, this client will require a browser redirect in order to perform a logout. Defaults to true.", "type": [ "boolean", "null" ] }, "fullScopeAllowed": { "description": "- Allow to include all roles mappings in the access token", "type": [ "boolean", "null" ] }, "idpInitiatedSsoRelayState": { "description": "Relay state you want to send with SAML request when you want to do IDP Initiated SSO.", "type": [ "string", "null" ] }, "idpInitiatedSsoUrlName": { "description": "URL fragment name to reference client when you want to do IDP Initiated SSO.", "type": [ "string", "null" ] }, "includeAuthnStatement": { "description": "When true, an AuthnStatement will be included in the SAML response. Defaults to true.", "type": [ "boolean", "null" ] }, "loginTheme": { "description": "The login theme of this client.", "type": [ "string", "null" ] }, "logoutServicePostBindingUrl": { "description": "SAML POST Binding URL for the client's single logout service.", "type": [ "string", "null" ] }, "logoutServiceRedirectBindingUrl": { "description": "SAML Redirect Binding URL for the client's single logout service.", "type": [ "string", "null" ] }, "masterSamlProcessingUrl": { "description": "When specified, this URL will be used for all SAML requests.", "type": [ "string", "null" ] }, "name": { "description": "The display name of this client in the GUI.", "type": [ "string", "null" ] }, "nameIdFormat": { "description": "Sets the Name ID format for the subject.", "type": [ "string", "null" ] }, "realmId": { "description": "The realm this client is attached to.", "type": [ "string", "null" ] }, "realmIdRef": { "additionalProperties": false, "description": "Reference to a Realm in realm to populate realmId.", "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" ] }, "realmIdSelector": { "additionalProperties": false, "description": "Selector for a Realm in realm to populate realmId.", "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" ] }, "rootUrl": { "description": "When specified, this value is prepended to all relative URLs.", "type": [ "string", "null" ] }, "signAssertions": { "description": "When true, the SAML assertions will be signed by Keycloak using the realm's private key, and embedded within the SAML XML Auth response. Defaults to false.", "type": [ "boolean", "null" ] }, "signDocuments": { "description": "When true, the SAML document will be signed by Keycloak using the realm's private key. Defaults to true.", "type": [ "boolean", "null" ] }, "signatureAlgorithm": { "description": "The signature algorithm used to sign documents. Should be one of \"RSA_SHA1\", \"RSA_SHA256\", \"RSA_SHA256_MGF1, \"RSA_SHA512\", \"RSA_SHA512_MGF1\" or \"DSA_SHA1\".", "type": [ "string", "null" ] }, "signatureKeyName": { "description": "The value of the KeyName element within the signed SAML document. Should be one of \"NONE\", \"KEY_ID\", or \"CERT_SUBJECT\". Defaults to \"KEY_ID\".", "type": [ "string", "null" ] }, "signingCertificateSecretRef": { "additionalProperties": false, "description": "If documents or assertions from the client are signed, this certificate will be used to verify the signature.", "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" ] }, "signingPrivateKeySecretRef": { "additionalProperties": false, "description": "If documents or assertions from the client are signed, this private key will be used to verify the signature.", "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" ] }, "validRedirectUris": { "description": "When specified, Keycloak will use this list to validate given Assertion Consumer URLs specified in the authentication request.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" } }, "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.clientId is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.clientId) || (has(self.initProvider) \u0026\u0026 has(self.initProvider.clientId))" } ] }, "status": { "additionalProperties": false, "description": "ClientStatus defines the observed state of Client.", "properties": { "atProvider": { "additionalProperties": false, "properties": { "alwaysDisplayInConsole": { "description": "Always list this client in the Account UI, even if the user does not have an active session.", "type": [ "boolean", "null" ] }, "assertionConsumerPostUrl": { "description": "SAML POST Binding URL for the client's assertion consumer service (login responses).", "type": [ "string", "null" ] }, "assertionConsumerRedirectUrl": { "description": "SAML Redirect Binding URL for the client's assertion consumer service (login responses).", "type": [ "string", "null" ] }, "authenticationFlowBindingOverrides": { "description": "Override realm authentication flow bindings", "items": { "additionalProperties": false, "properties": { "browserId": { "description": "Browser flow id, (flow needs to exist)", "type": [ "string", "null" ] }, "directGrantId": { "description": "Direct grant flow id (flow needs to exist)", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "baseUrl": { "description": "When specified, this URL will be used whenever Keycloak needs to link to this client.", "type": [ "string", "null" ] }, "canonicalizationMethod": { "description": "The Canonicalization Method for XML signatures. Should be one of \"EXCLUSIVE\", \"EXCLUSIVE_WITH_COMMENTS\", \"INCLUSIVE\", or \"INCLUSIVE_WITH_COMMENTS\". Defaults to \"EXCLUSIVE\".", "type": [ "string", "null" ] }, "clientId": { "description": "The unique ID of this client, referenced in the URI during authentication and in issued tokens.", "type": [ "string", "null" ] }, "clientSignatureRequired": { "description": "When true, Keycloak will expect that documents originating from a client will be signed using the certificate and/or key configured via signing_certificate and signing_private_key. Defaults to true.", "type": [ "boolean", "null" ] }, "consentRequired": { "description": "When true, users have to consent to client access. Defaults to false.", "type": [ "boolean", "null" ] }, "description": { "description": "The description of this client in the GUI.", "type": [ "string", "null" ] }, "enabled": { "description": "When false, this client will not be able to initiate a login or obtain access tokens. Defaults to true.", "type": [ "boolean", "null" ] }, "encryptAssertions": { "description": "When true, the SAML assertions will be encrypted by Keycloak using the client's public key. Defaults to false.", "type": [ "boolean", "null" ] }, "encryptionAlgorithm": { "description": "Algorithm used to encrypt SAML assertions. Allowed values: AES_256_GCM, AES_192_GCM, AES_128_GCM, AES_256_CBC, AES_192_CBC, or AES_128_CBC.", "type": [ "string", "null" ] }, "encryptionCertificateSha1": { "description": "(Computed) The sha1sum fingerprint of the encryption certificate. If the encryption certificate is not in correct base64 format, this will be left empty.", "type": [ "string", "null" ] }, "encryptionDigestMethod": { "description": "Digest method used with SAML encryption. Allowed values: SHA-512, SHA-256, or SHA-1. Only valid when encryption_key_algorithm is RSA-OAEP-11 or RSA-OAEP-MGF1P. Default is SHA-256.", "type": [ "string", "null" ] }, "encryptionKeyAlgorithm": { "description": "Key transport algorithm used by the client to encrypt the secret key for SAML assertion encryption. Allowed values: RSA-OAEP-11, RSA-OAEP-MGF1P, or RSA1_5. Default is RSA-OAEP-11.", "type": [ "string", "null" ] }, "encryptionMaskGenerationFunction": { "description": "Mask generation function used with SAML encryption. Allowed values: mgf1sha1, mgf1sha224, mgf1sha256, mgf1sha384, or mgf1sha512. Only valid when encryption_key_algorithm is RSA-OAEP-11. Default is mgf1sha256.", "type": [ "string", "null" ] }, "extraConfig": { "additionalProperties": { "type": "string" }, "description": "A map of key/value pairs to add extra configuration attributes to this client. Use this attribute at your own risk, as s may conflict with top-level configuration attributes in future provider updates.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "forceNameIdFormat": { "description": "Ignore requested NameID subject format and use the one defined in name_id_format instead. Defaults to false.", "type": [ "boolean", "null" ] }, "forcePostBinding": { "description": "When true, Keycloak will always respond to an authentication request via the SAML POST Binding. Defaults to true.", "type": [ "boolean", "null" ] }, "frontChannelLogout": { "description": "When true, this client will require a browser redirect in order to perform a logout. Defaults to true.", "type": [ "boolean", "null" ] }, "fullScopeAllowed": { "description": "- Allow to include all roles mappings in the access token", "type": [ "boolean", "null" ] }, "id": { "type": [ "string", "null" ] }, "idpInitiatedSsoRelayState": { "description": "Relay state you want to send with SAML request when you want to do IDP Initiated SSO.", "type": [ "string", "null" ] }, "idpInitiatedSsoUrlName": { "description": "URL fragment name to reference client when you want to do IDP Initiated SSO.", "type": [ "string", "null" ] }, "includeAuthnStatement": { "description": "When true, an AuthnStatement will be included in the SAML response. Defaults to true.", "type": [ "boolean", "null" ] }, "loginTheme": { "description": "The login theme of this client.", "type": [ "string", "null" ] }, "logoutServicePostBindingUrl": { "description": "SAML POST Binding URL for the client's single logout service.", "type": [ "string", "null" ] }, "logoutServiceRedirectBindingUrl": { "description": "SAML Redirect Binding URL for the client's single logout service.", "type": [ "string", "null" ] }, "masterSamlProcessingUrl": { "description": "When specified, this URL will be used for all SAML requests.", "type": [ "string", "null" ] }, "name": { "description": "The display name of this client in the GUI.", "type": [ "string", "null" ] }, "nameIdFormat": { "description": "Sets the Name ID format for the subject.", "type": [ "string", "null" ] }, "realmId": { "description": "The realm this client is attached to.", "type": [ "string", "null" ] }, "rootUrl": { "description": "When specified, this value is prepended to all relative URLs.", "type": [ "string", "null" ] }, "signAssertions": { "description": "When true, the SAML assertions will be signed by Keycloak using the realm's private key, and embedded within the SAML XML Auth response. Defaults to false.", "type": [ "boolean", "null" ] }, "signDocuments": { "description": "When true, the SAML document will be signed by Keycloak using the realm's private key. Defaults to true.", "type": [ "boolean", "null" ] }, "signatureAlgorithm": { "description": "The signature algorithm used to sign documents. Should be one of \"RSA_SHA1\", \"RSA_SHA256\", \"RSA_SHA256_MGF1, \"RSA_SHA512\", \"RSA_SHA512_MGF1\" or \"DSA_SHA1\".", "type": [ "string", "null" ] }, "signatureKeyName": { "description": "The value of the KeyName element within the signed SAML document. Should be one of \"NONE\", \"KEY_ID\", or \"CERT_SUBJECT\". Defaults to \"KEY_ID\".", "type": [ "string", "null" ] }, "signingCertificateSha1": { "description": "(Computed) The sha1sum fingerprint of the signing certificate. If the signing certificate is not in correct base64 format, this will be left empty.", "type": [ "string", "null" ] }, "signingPrivateKeySha1": { "description": "(Computed) The sha1sum fingerprint of the signing private key. If the signing private key is not in correct base64 format, this will be left empty.", "type": [ "string", "null" ] }, "validRedirectUris": { "description": "When specified, Keycloak will use this list to validate given Assertion Consumer URLs specified in the authentication request.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" } }, "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" }