GitLab Documentation

JWT OmniAuth provider

JWT OmniAuth provider

To enable the JWT OmniAuth provider, you must register your application with JWT. JWT will provide you with a secret key for you to use.

  1. 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
    
  2. See Initial OmniAuth Configuration for initial settings.

  3. Add the provider configuration.

    For Omnibus GitLab:

    gitlab_rails['omniauth_providers'] = [
      { name: 'jwt',
        app_secret: 'YOUR_APP_SECRET',
        args: {
                algorithm: 'HS256',
                uid_claim: 'email',
                required_claims: ["name", "email"],
                info_maps: { name: "name", email: "email" },
                auth_url: 'https://example.com/',
                valid_within: nil,
              }
      }
    ]
    

    For installation from source:

    - { name: 'jwt',
        app_secret: 'YOUR_APP_SECRET',
        args: {
                algorithm: 'HS256',
                uid_claim: 'email',
                required_claims: ["name", "email"],
                info_map: { name: "name", email: "email" },
                auth_url: 'https://example.com/',
                valid_within: nil,
              }
      }
    
    Note: For more information on each configuration option refer to the OmniAuth JWT usage documentation.
  4. Change YOUR_APP_SECRET to the client secret and set auth_url to your redirect URL.

  5. Save the configuration file.

  6. Reconfigure GitLab or restart GitLab for the changes to take effect if you installed GitLab via Omnibus or from source respectively.

On the sign in page there should now be a JWT icon below the regular sign in form. Click the icon to begin the authentication process. JWT will ask the user to sign in and authorize the GitLab application. If everything goes well, the user will be redirected to GitLab and will be signed in.

Was this helpful? Do you think that something is unclear? Use the comments area below and leave your feedback. For support and other enquiries, see getting help.