2023-06-14 19:51:57 -07:00

2.5 KiB

title slug
Custom OIDC SSO for Bare Metal /deployment/security/custom-oidc/bare-metal

Custom OIDC SSO for Bare Metal

Update conf/openmetadata.yaml

Once the Client Id and Client Secret are generated add the Client Id in openmetadata.yaml file in client_id field.

Update the providerName config to the name you want to display in the Sign In button in the UI. For example, with the following configuration with providerName set to KeyCloak, the users will see Sign In with KeyCloak SSO in the Sign In page of the OpenMetadata UI.

{% note noteType="Warning" %}

It is important to leave the publicKeys configuration to have both Custom OIDC public keys URL and OpenMetadata public keys URL.

  1. Custom OIDC SSO Public Keys are used to authenticate User's login
  2. OpenMetadata JWT keys are used to authenticate Bot's login
  3. Important to update the URLs documented in below configuration. The below config reflects a setup where all dependencies are hosted in a single host. Example openmetadata:8585 might not be the same domain you may be using in your installation.
  4. OpenMetadata ships default public/private key, These must be changed in your production deployment to avoid any security issues.

For more details, follow Enabling JWT Authenticaiton

{% /note %}

authenticationConfiguration:
  provider: "custom-oidc"
  providerName: "KeyCloak"
  publicKeyUrls:
    - "http://localhost:8080/realms/myrealm/protocol/openid-connect/certs"
    - "http://openmetadata:8585/api/v1/system/config/jwks"
  authority: "http://localhost:8080/realms/myrealm"
  clientId: "{client id}"
  callbackUrl: "http://localhost:8585/callback"
  • Update authorizerConfiguration to add login names of the admin users in section as shown below. Make sure you configure the name from email, example: xyz@helloworld.com, initialAdmins username will be ```xyz``
  • Update the principalDomain to your company domain name. Example from above, principalDomain should be helloworld.com
authorizerConfiguration:
  className: "org.openmetadata.service.security.DefaultAuthorizer"
  # JWT Filter
  containerRequestFilter: "org.openmetadata.service.security.JwtFilter"
  adminPrincipals:
    - "user1"
    - "user2"
  principalDomain: "open-metadata.org"

{% note noteType="Tip" %} Follow this guide to configure the ingestion-bot credentials for ingesting data using Connectors. {% /note %}