mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-15 13:10:44 +00:00
4.8 KiB
4.8 KiB
title | slug |
---|---|
Auth0 SSO | /deployment/security/auth0 |
Auth0 SSO
Follow the sections in this guide to set up Auth0 SSO.
Step 1: Create the Account
- If you don't have an account, Sign up to create one.
- Select the Account Type, i.e., Company or Personal
- Click I need advanced settings and click next.

- Provide the Tenant Domain, select the region and click on Create Account.

- Once done, you will land on the dashboard page.

Step 2: Create a New Application
- Once you are on the Dashboard page, click on
Applications > Applications
available on the left-hand side panel.

- Click on
Create Application
.

- Enter the Application name.
- Choose an application type and click on
Create
.

Step 3: Where to Find the Credentials
- Navigate to the Settings tab.
- You will find your
Client ID
,Client Secret
andDomain
.

This section will guide to create the Ingestion Bot service account.
Step 1: Enable Client-Credential
- Go to your project dashboard.

- Navigate to
Applications > Applications

- Select your application from the list.

- Once selected, scroll down until you see the
Application Properties
section. - Change the Token Endpoint
Authentication Method
fromNone
toBasic
.

- Now scroll further down to the section on
Advanced Settings
. - Click on it and select
Grant Types
. - In the
Grant Types
, check the option forClient Credentials
.

- Once done, click on
Save Changes
.
Step 2: Authorize the API with our Application.
- Navigate to
Applications > APIs
from the left menu.

- You will see the
Auth0 Management API
.

- Click on the
Auth0 Management API
.

- Click on the
Machine to Machine Applications
tab. - You will find your application listed below.

- Click on the toggle to authorize.
- Once done you will find a down arrow, click on it.

- Select the permissions (scopes) that should be granted to the client.
- Click on
Update
.

After the applying these steps, you can update the configuration of your deployment:
Configure Auth0 SSO for your Docker Deployment. Configure Auth0 SSO for your Bare Metal Deployment. 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: auth0
securityConfig:
clientId: '{your_client_id}'
secretKey: '{your_client_secret}'
domain: '{your_domain}'