Google SSO

Follow the sections in this guide to set up Google SSO.

priority_high

Important

Security requirements for your production environment:

DELETE the admin default account shipped by OM in case you had Basic Authentication enabled before configuring the authentication with Google SSO.
UPDATE the Private / Public keys used for the JWT Tokens. The keys we provide by default are aimed only for quickstart and testing purposes. They should NEVER be used in a production installation.

Create Server Credentials

Step 1: Create the Account

Go to Create Google Cloud Account
Click on Create Project

Create a New Account

Step 2: Create a New Project

Enter the Project name. Enter the parent organization or folder in the Location box. That resource will be the hierarchical parent of the new project. Click Create.

Create a New Project

Step 3: How to Configure OAuth Consent

Select the project you created above and click on APIs & Services on the left-side panel.
Click on the OAuth Consent Screen available on the left-hand side panel.
Choose User Type Internal.
Once the user type is selected, provide the App Information and other details.
Click Save and Continue.
On the Scopes Screen, Click on ADD OR REMOVE SCOPES and select the scopes.
Once done click on Update.
Click Save and Continue.
Click on Back to Dashboard.

Step 4: Create Credentials for the Project

Once the OAuth Consent is configured, click on Credentials available on the left-hand side panel.
Click on Create Credentials
Select OAuth client ID from the dropdown.
Once selected, you will be asked to select the Application type. Select Web application.

After selecting the Application Type, name your project and give the authorized URIs:

domain/callback
domain/silent-callback
Click Create
You will get the credentials

Step 5: Where to Find the Credentials

Go to Credentials
Click on the pencil icon (Edit OAuth Client) on the right side of the screen
You will find the Client ID and Client Secret in the top right corner

Create Service Account (optional)

This is a guide to create ingestion bot service account. This step is optional if you configure the ingestion-bot with the JWT Token, you can follow the documentation of Enable JWT Tokens.

Step 1: Create Service-Account

Navigate to your project dashboard
Click on Credentials on the left side panel
Click on Manage service accounts available on the center-right side.
Click on CREATE SERVICE ACCOUNT
Provide the required service account details.

Note

Ensure that the Service Account ID is ingestion-bot and click on CREATE AND CONTINUE. If you chose a different Service Account Id, add it to the default bots in OpenMetadata Server Configuration -> authorizerConfig section

Click on Select a role and give the Owner role. Then click Continue.

Click DONE

Now you should see your service account listed.

Step 2: Enable Domain-Wide Delegation

Click on the service account in the list.

On the details page, click on SHOW DOMAIN-WIDE DELEGATION
Enable Google Workspace Domain-wide Delegation
Click on SAVE

How to Generate Private-Key/Service-Account JSON File

Once done with the above steps, click on KEYS available next to the DETAILS tab.
Click on ADD KEY and select Create a new key.
Select the format. The JSON format is recommended.
Next, click on CREATE
The private-key/service-account JSON file will be downloaded.

After the applying these steps, you can update the configuration of your deployment:

Docker Security Configure Auth0 SSO for your Docker Deployment.

Bare Metal Security Configure Auth0 SSO for your Bare Metal Deployment.

Kubernetes Security Configure Auth0 SSO for your Kubernetes Deployment.

Configure Ingestion

After everything has been set up, you will need to configure your workflows if you are running them via the metadata CLI or with any custom scheduler.

When setting up the YAML config for the connector, update the workflowConfig as follows:

workflowConfig:
  openMetadataServerConfig:
    hostPort: 'http://localhost:8585/api'
    authProvider: google
    securityConfig:
      secretKey: '{path-to-json-creds}'