Docs: Private key note added (#18727)

open-metadata · Nov 22, 2024 · 92145cd · 92145cd
1 parent 702c34c
commit 92145cd
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/openmetadata-docs/content/v1.5.x/deployment/security/saml/index.md b/openmetadata-docs/content/v1.5.x/deployment/security/saml/index.md
@@ -39,6 +39,12 @@ Every IDP provides this information, we can download the XML Metadata and config
 
 {% note %}
 
+When configuring the Private Key for the Service Provider, ensure you use the actual key content enclosed within the `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----` block. Avoid using the Base64-encoded format of the key, as this is not the expected value.
+
+{% /note %}
+
+{% note %}
+
 To add a private key, you need to include it in the keystore and update the configuration details accordingly [here](https://github.com/open-metadata/OpenMetadata/blob/main/conf/openmetadata.yaml#L219).
 
 ```yaml

diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/saml/index.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/deployment/security/saml/index.md
@@ -39,6 +39,12 @@ Every IDP provides this information, we can download the XML Metadata and config
 
 {% note %}
 
+When configuring the Private Key for the Service Provider, ensure you use the actual key content enclosed within the `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----` block. Avoid using the Base64-encoded format of the key, as this is not the expected value.
+
+{% /note %}
+
+{% note %}
+
 To add a private key, you need to include it in the keystore and update the configuration details accordingly [here](https://github.com/open-metadata/OpenMetadata/blob/main/conf/openmetadata.yaml#L219).
 
 ```yaml