SSO to Databricks with OneLogin

This article shows how to configure OneLogin as the identity provider for single sign-on (SSO) in your Databricks account. OneLogin supports both OpenID Connect (OIDC) and SAML 2.0. To sync users and groups from OneLogin, see Sync users and groups from your identity provider.

Warning

To prevent getting locked out of Databricks during single sign-on testing, Databricks recommends keeping the account console open in a different browser window. You can also configure emergency access with security keys to prevent lockout. See Emergency access to prevent lockouts.

Enable OneLogin SSO using OIDC

  1. As an account owner or account admin, log in to the account console and click the Settings icon in the sidebar.

  2. Click the Authentication tab.

  3. Next to Authentication, click Manage.

  4. Choose Single sign-on with my identity provider.

  5. Click Continue.

  6. Under Identity protocol, select OpenID Connect.

  7. On the Authentication tab, make note of the Databricks Redirect URL value.

    Configure SAML SSO.

  8. In a new browser tab, log in to OneLogin.

  9. Click Administration.

  10. Click Applications.

  11. Click Add App.

  12. Search for OpenId Connect and select the OpenId Connect (OIDC) app.

  13. Enter a name and click Save.

  14. In the Configuration tab, Databricks Redirect URL from step 4. You can choose to configure the other settings or you can leave them to their default values.

  15. In the SSO tab, copy the copy the client ID, client secret, and issuer URL values.

    • Client ID is the unique identifier for the Databricks application you created in OneLogin.

    • Client secret is a secret or password generated for the Databricks application that you created. It is used to authorize Databricks with your identity provider.

    • Issuer URL is the URL where you can find OneLogin’s OpenID Configuration Document. That OpenID Configuration Document must found be in {issuer-url}/.well-known/openid-configuration.

      Remove the /.well-known/openid-configuration ending from the URL. You can specify query parameters by appending them to the issuer URL, for example {issuer-url}?appid=123.

  16. Return to the Databricks account console Authentication tab and enter values you copied from the identity provider application to the Client ID, Client secret, and OpenID issuer URL fields.

  17. Optionally, enter a Username claim if you want to use a claim other than email as users’ Databricks usernames. See your identity provider’s documentation for specific information on claim values.

    Single sign-on tab when all values have been entered

  18. Click Save.

  19. Click Test SSO to validate that your SSO configuration is working properly.

  20. Click Enable SSO to enable single sign-on for your account.

  21. Test account console login with SSO.

  22. Configure unified login

    Unified login allows you to use the account console SSO configuration in your Databricks workspaces. If your account was created after June 21, 2023, unified login is enabled on your account by default for all workspaces, new and existing, and it cannot be disabled. To configure unified login, see Enable unified login.

Enable OneLogin SSO using SAML

Follow these steps to create a OneLogin SAML application for use with Databricks account console.

  1. As an account owner or account admin, log in to the account console and click the Settings icon in the sidebar.

  2. Click the Authentication tab.

  3. Next to Authentication, click Manage.

  4. Choose Single sign-on with my identity provider.

  5. Click Continue.

  6. Under Identity protocol, select SAML 2.0.

  7. On the Authentication tab, make note of the Databricks Redirect URL value.

  8. In a new browser tab, log in to OneLogin.

  9. Click Administration.

  10. Click Applications.

  11. Click Add App.

  12. Search for SAML Custom Connector (Advanced) and click the result by OneLogin, Inc.

  13. Set Display Name to Databricks.

  14. Click Save. The application’s Info tab loads.

  15. Click Configuration.

  16. In Gather required information, set each of the following fields to the Databricks SAML URL:

    • Audience

    • Recipient

    • ACS (Consumer) URL Validator

    • ACS (Consumer) URL

    • Single Logout URL

    • Login URL

  17. Set SAML signature element to Both.

  18. Click Parameters.

  19. Set Credentials are to Configured by admins and shared by all users.

  20. Click Email. Set the value to email and enable Include in SAML Assertion.

  21. Click the SSO tab.

  22. Copy the following values:

    • x.509 certificate

    • Issuer URL

    • SAML 2.0 endpoint (HTTP)

  23. Verify that SAML signature element is set to Response or Both.

  24. Verify that Encrypt assertion is disabled.

  25. Configure Databricks in the Databricks account console SSO page.

    1. Set the SSO type drop-down to SAML 2.0.

    2. Set Single Sign-On URL to the OneLogin SAML 2.0 endpoint.

    3. Set Identity Provider Entity ID to the OneLogin Issuer URL.

    4. Set x.509 Certificate to the OneLogin x.509 certificate, including the markers for the beginning and ending of the certificate.

    5. Click Save.

    6. Click Test SSO to validate that your SSO configuration is working properly.

    7. Click Enable SSO to enable single sign-on for your account.

    8. Test account console login with SSO.

  26. Configure unified login

    Unified login allows you to use the account console SSO configuration in your Databricks workspaces. If your account was created after June 21, 2023, unified login is enabled on your account by default for all workspaces, new and existing, and it cannot be disabled. To configure unified login, see Enable unified login.