docs: Fix documented API Endpoint url for PublicKeys (#14594)

open-metadata · Jan 5, 2024 · ec32d9c · ec32d9c
1 parent 0255171
commit ec32d9c
Show file tree

Hide file tree

Showing 22 changed files with 22 additions and 22 deletions.
diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/auth0/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/auth0/docker.md
@@ -20,7 +20,7 @@ AUTHORIZER_ADMIN_PRINCIPALS=[admin]  # Your `name` from name@domain.com
 AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=auth0
-AUTHENTICATION_PUBLIC_KEYS=[{Domain}/.well-known/jwks.json,http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[{Domain}/.well-known/jwks.json,http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 
 AUTHENTICATION_AUTHORITY={Domain} # Update with your Domain
 AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/auth0/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/auth0/kubernetes.md
@@ -22,7 +22,7 @@ openmetadata:
     authentication:
       provider: "auth0"
       publicKeys: 
-      - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+      - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
       - "{Auth0 Domain Name}/.well-known/jwks.json"
       authority: "https://parth-panchal.us.auth0.com/"
       clientId: "{Client ID}"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/azure/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/azure/bare-metal.md
@@ -16,7 +16,7 @@ authenticationConfiguration:
   provider: "azure"
   publicKeyUrls:
     - "https://login.microsoftonline.com/common/discovery/keys"
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: "https://login.microsoftonline.com/{Tenant ID}"
   clientId: "{Client ID}" # Azure Application
   callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/azure/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/azure/docker.md
@@ -24,7 +24,7 @@ AUTHORIZER_ADMIN_PRINCIPALS=[admin]  # Your `name` from name@domain.com
 AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=azure
-AUTHENTICATION_PUBLIC_KEYS=[https://login.microsoftonline.com/common/discovery/keys, http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[https://login.microsoftonline.com/common/discovery/keys, http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 AUTHENTICATION_AUTHORITY=https://login.microsoftonline.com/{Tenant ID} # Update with your Tenant ID
 AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID of Azure Application
 AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/azure/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/azure/kubernetes.md
@@ -26,7 +26,7 @@ openmetadata:
     authentication:
       provider: "azure"
       publicKeys:
-      - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+      - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
       - "https://login.microsoftonline.com/common/discovery/keys"
       authority: "https://login.microsoftonline.com/{Tenant ID}"
       clientId: "{Client ID}" # Azure Application

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.2.x/deployment/security/basic-auth/index.md
@@ -35,7 +35,7 @@ The following configuration controls the auth mechanism for OpenMetadata. Update
 ```yaml
 authenticationConfiguration:
   provider: ${AUTHENTICATION_PROVIDER:-basic}
-  publicKeyUrls: ${AUTHENTICATION_PUBLIC_KEYS:-[http://{your openmetadata domain}/api/v1/config/jwks]} # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+  publicKeyUrls: ${AUTHENTICATION_PUBLIC_KEYS:-[http://{your openmetadata domain}/api/v1/system/config/jwks]} # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: ${AUTHENTICATION_AUTHORITY:-https://accounts.google.com}
   enableSelfSignup : ${AUTHENTICATION_ENABLE_SELF_SIGNUP:-true}
 ```

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/custom-oidc/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/custom-oidc/bare-metal.md
@@ -19,7 +19,7 @@ authenticationConfiguration:
   providerName: "KeyCloak"
   publicKeyUrls:
     - "http://localhost:8080/realms/myrealm/protocol/openid-connect/certs"
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: "http://localhost:8080/realms/myrealm"
   clientId: "{client id}"
   callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/custom-oidc/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/custom-oidc/docker.md
@@ -21,7 +21,7 @@ AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=custom-oidc
 CUSTOM_OIDC_AUTHENTICATION_PROVIDER_NAME=KeyCloak
-AUTHENTICATION_PUBLIC_KEYS=[http://localhost:8080/realms/myrealm/protocol/openid-connect/certs, http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[http://localhost:8080/realms/myrealm/protocol/openid-connect/certs, http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 AUTHENTICATION_AUTHORITY={http://localhost:8080/realms/myrealm}
 AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID
 AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/custom-oidc/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/custom-oidc/kubernetes.md
@@ -22,7 +22,7 @@ global:
   authentication:
     provider: "custom-oidc"
     publicKeys:
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
     - "http://localhost:8080/realms/myrealm/protocol/openid-connect/certs"
     authority: "http://localhost:8080/realms/myrealm"
     clientId: "{Client ID}"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/google/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/google/bare-metal.md
@@ -14,7 +14,7 @@ authenticationConfiguration:
   provider: "google"
   publicKeyUrls:
     - "https://www.googleapis.com/oauth2/v3/certs"
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: "https://accounts.google.com"
   clientId: "{client id}"
   callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/google/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/google/docker.md
@@ -21,7 +21,7 @@ AUTHORIZER_INGESTION_PRINCIPALS=[ingestion-bot]
 AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=google
-AUTHENTICATION_PUBLIC_KEYS=[https://www.googleapis.com/oauth2/v3/certs, http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[https://www.googleapis.com/oauth2/v3/certs, http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 AUTHENTICATION_AUTHORITY=https://accounts.google.com
 AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Google SSO Client ID
 AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/google/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/google/kubernetes.md
@@ -27,7 +27,7 @@ openmetadata:
       provider: "google"
       publicKeys:
         - "https://www.googleapis.com/oauth2/v3/certs"
-        - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+        - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
       authority: "https://accounts.google.com"
       clientId: "{client id}"
       callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/keycloak/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/keycloak/bare-metal.md
@@ -20,7 +20,7 @@ authenticationConfiguration:
   providerName: "KeyCloak"
   publicKeyUrls:
     - "http://localhost:8081/auth/realms/data-sec/protocol/openid-connect/certs"
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: "http://localhost:8081/auth/realms/data-sec"
   clientId: "open-metadata"
   callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/keycloak/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/keycloak/docker.md
@@ -23,7 +23,7 @@ AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=custom-oidc
 CUSTOM_OIDC_AUTHENTICATION_PROVIDER_NAME=KeyCloak
-AUTHENTICATION_PUBLIC_KEYS=[http://localhost:8081/auth/realms/data-sec/protocol/openid-connect/certs, http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[http://localhost:8081/auth/realms/data-sec/protocol/openid-connect/certs, http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 AUTHENTICATION_AUTHORITY={http://localhost:8081/auth/realms/data-sec}
 AUTHENTICATION_CLIENT_ID=open-metadata # Update with your Client ID
 AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/keycloak/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/keycloak/kubernetes.md
@@ -24,7 +24,7 @@ openmetadata:
     authentication:
       provider: "custom-oidc"
       publicKeys:
-      - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+      - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
       - "http://localhost:8081/auth/realms/data-sec/protocol/openid-connect/certs"
       authority: "http://localhost:8081/auth/realms/data-sec"
       clientId: "{Client ID}"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/ldap/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/ldap/bare-metal.md
@@ -14,7 +14,7 @@ The following configuration controls the auth mechanism for OpenMetadata. Update
 ```yaml
 authenticationConfiguration:
   provider: ${AUTHENTICATION_PROVIDER:-ldap}
-  publicKeyUrls: ${AUTHENTICATION_PUBLIC_KEYS:-[http://{your openmetadata domain}/api/v1/config/jwks]} # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+  publicKeyUrls: ${AUTHENTICATION_PUBLIC_KEYS:-[http://{your openmetadata domain}/api/v1/system/config/jwks]} # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: ${AUTHENTICATION_AUTHORITY:-https://accounts.google.com}
   enableSelfSignup : ${AUTHENTICATION_ENABLE_SELF_SIGNUP:-false}
   ldapConfiguration:

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md
@@ -14,7 +14,7 @@ authenticationConfiguration:
   provider: "okta"
   publicKeyUrls:
     - "{ISSUER_URL}/v1/keys"
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: "{ISSUER_URL}"
   clientId: "{CLIENT_ID - SPA APP}"
   callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/okta/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/okta/docker.md
@@ -27,7 +27,7 @@ AUTHORIZER_INGESTION_PRINCIPALS=[ingestion-bot, <service_application_client_id>]
 AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=okta
-AUTHENTICATION_PUBLIC_KEYS=[{ISSUER_URL}/v1/keys, http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[{ISSUER_URL}/v1/keys, http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 AUTHENTICATION_AUTHORITY={ISSUER_URL} # Update with your Issuer URL
 AUTHENTICATION_CLIENT_ID={CLIENT_ID - SPA APP} # Update with your Client ID
 AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/okta/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/okta/kubernetes.md
@@ -25,7 +25,7 @@ openmetadata:
     authentication:
       provider: "okta"
       publicKeys:
-      - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+      - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
       - "{ISSUER_URL}/v1/keys"
       authority: "{ISSUER_URL}"
       clientId: "{CLIENT_ID - SPA APP}"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/one-login/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/one-login/bare-metal.md
@@ -19,7 +19,7 @@ authenticationConfiguration:
   providerName: "OneLogin"
   publicKeyUrls: 
     - "{IssuerUrl}/certs"
-    - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+    - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
   authority: "{IssuerUrl}"
   clientId: "{client id}"
   callbackUrl: "http://localhost:8585/callback"

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/one-login/docker.md b/openmetadata-docs/content/v1.2.x/deployment/security/one-login/docker.md
@@ -20,7 +20,7 @@ AUTHORIZER_ADMIN_PRINCIPALS=[admin]  # Your `name` from name@domain.com
 AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain
 
 AUTHENTICATION_PROVIDER=custom-oidc
-AUTHENTICATION_PUBLIC_KEYS=[{public key url}, http://{your openmetadata domain}/api/v1/config/jwks] # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+AUTHENTICATION_PUBLIC_KEYS=[{public key url}, http://{your openmetadata domain}/api/v1/system/config/jwks] # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
 AUTHENTICATION_AUTHORITY={issuer url} # Update with your Issuer URL
 AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID
 AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback

diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/one-login/kubernetes.md b/openmetadata-docs/content/v1.2.x/deployment/security/one-login/kubernetes.md
@@ -23,7 +23,7 @@ openmetadata:
     authentication:
       provider: "custom-oidc"
       publicKeys:
-      - "http://{your openmetadata domain}/api/v1/config/jwks" # Update with your Domain and Make sure this "/api/v1/config/jwks" is always configured to enable JWT tokens
+      - "http://{your openmetadata domain}/api/v1/system/config/jwks" # Update with your Domain and Make sure this "/api/v1/system/config/jwks" is always configured to enable JWT tokens
       - "{IssuerUrl}/certs"
       authority: "{IssuerUrl}"
       clientId: "{client id}"