gitlab-org--gitlab-foss/doc/integration/auth0.md

stage	group	info
none	unassigned	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers

Auth0 OmniAuth Provider

To enable the Auth0 OmniAuth provider, you must create an Auth0 account, and an application.

1. Sign in to the Auth0 Console. If you need to create an account, you can do so at the same link.

2. Select New App/API.

3. Provide the Application Name ('GitLab' works fine).

4. After creating, you should see the Quick Start options. Disregard them and select Settings above the Quick Start options.

5. At the top of the Settings screen, you should see your Domain, Client ID, and Client Secret. These values are needed in the configuration file. For example:

   • Domain: test1234.auth0.com
   • Client ID: t6X8L2465bNePWLOvt9yi41i
   • Client Secret: KbveM3nqfjwCbrhaUy_gDu2dss8TIlHIdzlyf33pB7dEK5u_NyQdp65O_o02hXs2

6. Fill in the Allowed Callback URLs:

   • http://YOUR_GITLAB_URL/users/auth/auth0/callback (or)
   • https://YOUR_GITLAB_URL/users/auth/auth0/callback

7. Fill in the Allowed Origins (CORS):

   • http://YOUR_GITLAB_URL (or)
   • https://YOUR_GITLAB_URL

8. On your GitLab server, open the configuration file.

   For Omnibus GitLab:

   sudo editor /etc/gitlab/gitlab.rb
   

   For installations from source:

   cd /home/git/gitlab
   sudo -u git -H editor config/gitlab.yml
   

9. Read Initial OmniAuth Configuration for initial settings.

10. Add the provider configuration:

    For Omnibus GitLab:

    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "auth0",
        "args" => { client_id: 'YOUR_AUTH0_CLIENT_ID',
                    client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
                    domain: 'YOUR_AUTH0_DOMAIN',
                    scope: 'openid profile email'
                  }
      }
    ]
    

    For installations from source:

    - { name: 'auth0',
        args: {
          client_id: 'YOUR_AUTH0_CLIENT_ID',
          client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
          domain: 'YOUR_AUTH0_DOMAIN',
          scope: 'openid profile email' }
      }
    

11. Change YOUR_AUTH0_CLIENT_ID to the client ID from the Auth0 Console page from step 5.

12. Change YOUR_AUTH0_CLIENT_SECRET to the client secret from the Auth0 Console page from step 5.

13. Reconfigure or restart GitLab, depending on your installation method:

    • If you installed from Omnibus GitLab, Reconfigure GitLab.
    • If you installed from source, restart GitLab.

On the sign-in page there should now be an Auth0 icon below the regular sign-in form. Click the icon to begin the authentication process. Auth0 asks the user to sign in and authorize the GitLab application. If the user authenticates successfully, the user is returned to GitLab and signed in.