Skip to main content
🛠 This page is for engineering teams self-hosting their own Lightdash instance. The environment variables listed below are set directly in your self-hosted deployment.Lightdash Cloud users: configure SSO yourself from Organization settings → Single Sign-On — see Configure SSO. Use the provider-side steps on this page (creating an OAuth app, configuring redirect URIs, etc.) to obtain the values, then enter them in the organization settings UI instead of setting environment variables.Cloud SSO also requires a verified domain. Saving provider credentials without a verified domain will not route users to that provider during sign-in.

​
Multiple authentication methods

Lightdash supports configuring multiple authentication methods simultaneously on a single instance. You can enable any combination of sign-in options, including:
  • Password + Okta
  • Password + Google + Okta
  • Multiple SSO providers (e.g., Google + Azure AD + One Login)
Simply configure the environment variables for each authentication method you want to enable, and all configured options will appear on your login page.

​
Passwords

We recommend adding the SMTP environment variables so Lightdash can display a Forgot your password? button in the login page and send emails to reset passwords. You can override a user password in just a few steps:
  1. Open the bash terminal for the docker Lightdash container
  2. Override user password with this command:

​
SSO setup

To enforce SSO, it’s recommended to disable password authentication. This can be done by setting the following environment variable:

​
Okta

Lightdash supports Okta as an authentication provider. The integration uses OpenID Connect (OIDC) to authenticate users and JIT provisioning to create users in Lightdash when they first log in.

​
Creating an Okta application

In the Okta admin panel, navigate to Applications and click Create App Integration, choose the following settings:
  • Sign-in method: OIDC - OpenID Connect
  • Application type: Web application
On the following page you’ll need to use the following settings, replace {{ lightdash_url }} with the URL of your Lightdash instance. For example if you normally access Lightdash at https://lightdash.example.com/login then you should use https://lightdash.example.com as your {{ lightdash_url }}.
  • Grant type: Authorization Code
  • Sign-in redirect URIs: {{ lightdash_url }}/api/v1/oauth/redirect/okta
  • Sign-out redirect URIs: {{ lightdash_url }}
  • Controlled access: Select who can access this application
Hit Save and you’ll be taken to the application settings page. For the optimal user experience, we recommend allowing Okta to initiate the login flow. To do this, click Edit next to General Settings and set:
  • Login initiated by: App and Okta Sign-in Page
  • Application visibility: Display application icon to users
  • Login flow: Redirect to app to initiate login (OIDC Compliant)
  • Initiate login URI: {{ lightdash_url }}/api/v1/login/okta
Hit Save to finish.

​
Okta configuration variables

From the application settings page, you’ll need to copy the following values:
  • Client ID
  • Client secret
You’ll also need your Okta domain, which is the first part of your okta URL. For example if your Okta URL is https://dev-123456.okta.com then your Okta domain is dev-123456.okta.com. Finally, you need the Issuer URI. This is the URL of your Okta authorization server. You can use your Org authorization server which uses https://dev-123456.okta.com as your issuer or select a custom authorization server. To find the issuer URI for a custom authorization server navigate to API > Authorization Servers and click on the authorization server and note the Issuer URI and Name of the authorization server. For example the default authorization server has an issuer URI of https://dev-123456.okta.com/oauth2/default.

​
Groups & Okta

If you want to use groups to control access to Lightdash, you’ll need to configure Okta and Lightdash to support this. If you’re not using a custom authorization server ID:
  • on OpenID Connect ID Token section in the Okta application settings, add groups to the Groups claim field, by setting a Groups claims type to Filter and a Filter to match expression to .*
If you’re using a custom authorization server ID:
  • you don’t need to set the AUTH_OKTA_EXTRA_SCOPES environment variable
  • on the Authorization Server settings, add claim groups, value type Groups, matches regex .*

​
Configuring Lightdash for Okta

Lightdash Cloud users: instead of setting these environment variables, enter the client ID, client secret, Okta domain, and issuer URI in Organization settings → Single Sign-On → Okta. See Configure SSO.Make sure your organization has a verified domain, otherwise Okta will not appear for users during sign-in.
You’ll need to set the following environment variables in your Lightdash deployment:

​
Enable Automatic Assignment of Okta Users to Groups in Lightdash

This feature is deprecated and will be removed in a future release.For more information on how to provision users and groups in Lightdash, see the SCIM integration documentation.
Okta users will automatically be assigned to the same groups in Lightdash as they are in Okta if you have configured Okta to share groups with Lightdash. To enable this functionality, ensure the following environment variable is set: read more about Using OKTA to manage groups in Lightdash

​
Google

To enable Google Single Sign On (SSO) you’ll need to follow these instructions to Create the OAuth web client ID. Once you reach Step 13 to configure the client you’ll need to enter the following details:
  • Authorized JavaScript Origins: https://{{ lightdash_domain }}
  • Authorized redirect URIs: https://{{ lightdash_domain }}/api/v1/oauth/redirect/google
Where {{ lightdash_domain }} is the domain you use to sign in to Lightdash such as mycompany.lightdash.com These environment variables must be provided to Lightdash to enable you to control Single Sign On (SSO) functionality for Google If you use BigQuery SSO to give users per-user warehouse credentials, set AUTH_GOOGLE_INCLUDE_BIGQUERY_SCOPE=true to request the BigQuery scope during the initial Google login. Users will complete one consent screen that covers both Lightdash login and BigQuery warehouse access instead of two separate OAuth flows. When enabled, Lightdash also requests offline access with a forced consent prompt so Google returns a refresh token for the BigQuery connection. Leave this unset (or false) if you do not use BigQuery SSO. Before enabling this option:
  • Confirm Google SSO is configured and working (AUTH_GOOGLE_ENABLED=true).
  • Add the https://www.googleapis.com/auth/bigquery scope to your OAuth consent screen in Google Cloud.
  • Enable BigQuery SSO at the project level for the warehouse connections that should use it.

​
One Login

To create a One Login integration:
  • Head to the Administration portal
  • In the navigation bar at the top select Applications > Applications
  • Hit the Add App button
  • Under Find Applications search for OpenID Connect (OIDC) and select it
  • Set the Display Name and for the Icon you can use our Lightdash Media Kit to get a Lightdash Bolt logo and press Save
  • Set the following values for the application
    • Configuration > Login URL {{site_url}}/api/v1/login/oneLogin
    • Configuration > Redirect URL {{site_url}}/api/v1/oauth/redirect/oneLogin
    • SSO > Application Type web
    • SSO > Token endpoint post
    • SSO > Enable login hint true
  • From the SSO page copy the client id, client secret, and issuer URL.
Lightdash Cloud users: instead of setting these environment variables, enter the client ID, client secret, and issuer URL in Organization settings → Single Sign-On → OneLogin. See Configure SSO.Make sure your organization has a verified domain, otherwise OneLogin will not appear for users during sign-in.
These variables enable you to control Single Sign On (SSO) functionality for One Login

​
Azure Active Directory

​
Creating an Azure AD application

In the admin panel, navigate to App Registrations and click New registration, choose the following settings for the redirect URI:
  • Type: Web
  • URI: {{ lightdash_url }}/api/v1/oauth/redirect/azuread
On the following page you’ll need to use the following settings, replace {{ lightdash_url }} with the URL of your Lightdash instance. For example if you normally access Lightdash at https://lightdash.example.com/login then you should use https://lightdash.example.com as your {{ lightdash_url }}. Hit Register and you’ll be taken to the application settings page. Copy the “Application (client) ID” and “Directory (tenant) ID” values as you’ll need them later. In the left hand menu, navigate to Certificates & secrets and click New client secret. Give the secret a description and choose an expiry time. Hit Add and you’ll be shown the secret value. Copy this value as you’ll need it later.

​
Configuring Lightdash for Azure AD

Lightdash Cloud users: instead of setting these environment variables, enter the client ID, client secret, and tenant ID in Organization settings → Single Sign-On → Azure AD. See Configure SSO.Make sure your organization has a verified domain, otherwise Azure AD will not appear for users during sign-in.
These variables enable you to control Single Sign On (SSO) functionality for Azure Active Directory.

​
OpenID Connect

Lightdash supports OpenID Connect-compliant SSO providers, via our configurable OIDC connector.

​
Configuring Lightdash for OpenID Connect

Lightdash Cloud users: instead of setting these environment variables, enter the client ID, client secret, and metadata document URL in Organization settings → Single Sign-On → OpenID Connect. See Configure SSO.Make sure your organization has a verified domain, otherwise OpenID Connect will not appear for users during sign-in.
These variables enable you to control Single Sign On (SSO) functionality for a generic OpenID Connect provider.