Skip to main content

​
UserName/Password Login

Out of the box, OpenMetadata comes with a Username & Password Login Mechanism. The default Username and Password for Login are:
When using a custom domain, configure the principal domain as follows:
With this setup, the default Username will be admin@yourdomain.com.
Security requirements for your production environment:
  • DELETE the admin default account shipped by OM.
  • UPDATE the Private / Public keys used for the JWT Tokens in case it is enabled.

​
Setting up Basic Auth Manually

Below are the required steps to set up the Basic Login:

​
Set up Configurations in openmetadata.yaml

​
Authentication Configuration

The following configuration controls the auth mechanism for OpenMetadata. Update the mentioned fields as required.
For the Basic auth we need to set:
  • provider: basic
  • publicKeyUrls: ://:}/api/v1/system/config/jwks
  • authority:
  • enableSelfSignup: This flag indicates if users can come and signup by themselves on the OM

​
Authorizer Configuration

This configuration controls the authorizer for OpenMetadata:
For the Basic auth we need to set:
  • adminPrincipals: admin usernames to bootstrap the server with, comma-separated values.
  • allowedEmailRegistrationDomains: This controls what all domain are allowed for email registration can be your as well, for example gmail.com, outlook.comm etc.
  • principalDomain: This controls what all domain are allowed for email registration, for example gmail.com, outlook.comm etc. When AUTHORIZER_ENFORCE_PRINCIPAL_DOMAIN is set to true, only users with email addresses from the AUTHORIZER_PRINCIPAL_DOMAIN can log in.
Starting in Collate 2.1, adminPrincipals and principalDomain are deprecated but still work. Use adminEmails to list admins by email address, allowedEmailDomains to restrict sign-in domains, and botDomain for bot email addresses. For more information, see Email-First User Identity.
Please note the following are the formats to bootstrap admins on server startup: [admin1,admin2,admin3]This works for SMTP-enabled servers, Login Password for these are generated randomly and sent to the mail adminName@principalDomain.If SMTP is not enabled for OpenMetadata, please use the method below to create admin users: [admin1, admin2, admin3]. The default password for all admin users will be admin.After logging into the OpenMetadata UI, admin users can change their default password by navigating to Settings > Members > Admins.

​
Metadata Ingestion

For ingesting metadata when Basic Auth is enabled, it is mandatory to configure the ingestion-bot account with the JWT configuration. To know how to enable it, you can follow the documentation of Enable JWT Tokens.

​
Setting up SMTP Server

Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the users to Reset Password, Account Status Updates, etc. as well.
Following are valid value for transportation strategy:
  • SMTP: If SMTP port is 25 use this
  • SMTPS: If SMTP port is 465 use this
  • SMTP_TLS: If SMTP port is 587 use this

​
Configure Ingestion

Once your server security is set, it’s time to review the ingestion configuration. Our bots support JWT tokens to authenticate to the server when sending requests. Find more information on Enabling JWT Tokens and JWT Troubleshooting to ensure seamless authentication.

​
Recover Access During an SSO Outage

Collate cannot run Basic Auth and single sign-on (SSO) at the same time. During an SSO outage, a self-managed or Bring Your Own Cloud (BYOC) operator can temporarily switch the server to Basic Auth. Fully managed Collate customers must contact Collate Support because only Collate can change the server authentication configuration.
Prepare and test a Basic Auth administrator account before an outage. Switching providers does not create a usable password for an existing SSO-only account. Changing the provider also invalidates sessions created by the previous provider, and restarting or rolling out the Collate server can briefly interrupt access.
For a self-managed or BYOC deployment:
  1. Confirm that you have deployment access and a tested Basic Auth administrator credential.
  2. Record the current SSO provider and configuration so you can restore them.
  3. Set authenticationConfiguration.provider to basic. If the configuration uses environment variables, set AUTHENTICATION_PROVIDER=basic.
  4. Restart the Collate server or roll out all Collate server pods so every instance uses the same provider.
  5. Open a private browser session and sign in with the Basic Auth administrator account.
  6. Restore service or correct the SSO configuration.
  7. Set authenticationConfiguration.provider back to the original SSO provider, restart or roll out every Collate server instance, and verify SSO sign-in.
After you restore SSO, users must sign in again because sessions issued by Basic Auth are no longer valid.