gitlab-org--gitlab-foss/doc/administration/auth/authentiq.md

type	stage	group	info
reference	Manage	Authentication and Authorization	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Authentiq OmniAuth Provider (FREE SELF)

To enable the Authentiq OmniAuth provider for passwordless authentication you must register an application with Authentiq.

Authentiq generates a Client ID and the accompanying Client Secret for you to use.

1. Get your Client credentials (Client ID and Client Secret) at Authentiq.

2. On your GitLab server, open the configuration file:

   For omnibus installation

   sudo editor /etc/gitlab/gitlab.rb
   

   For installations from source:

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

3. See Configure initial settings for initial settings to enable single sign-on and add Authentiq as an OAuth provider.

4. Add the provider configuration for Authentiq:

   For Omnibus packages:

   gitlab_rails['omniauth_providers'] = [
     {
       name: "authentiq",
       # label: "Provider name", # optional label for login button, defaults to "Authentiq"
       app_id: "YOUR_CLIENT_ID",
       app_secret: "YOUR_CLIENT_SECRET",
       args: {
         "scope": 'aq:name email~rs address aq:push'
       }
     }
   ]
   

   For installations from source:

   - { name: 'authentiq',
       # label: 'Provider name', # optional label for login button, defaults to "Authentiq"
       app_id: 'YOUR_CLIENT_ID',
       app_secret: 'YOUR_CLIENT_SECRET',
       args: {
              scope: 'aq:name email~rs address aq:push'
             }
     }
   

5. The scope is set to request the user's name, email (required and signed), and permission to send push notifications to sign in on subsequent visits. See OmniAuth Authentiq strategy for more information on scopes and modifiers.

6. Change YOUR_CLIENT_ID and YOUR_CLIENT_SECRET to the Client credentials you received in step 1.

7. Save the configuration file.

8. Reconfigure 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 an Authentiq icon below the regular sign in form. Click the icon to begin the authentication process. If the user:

• Has the Authentiq ID app installed in their iOS or Android device, they can:
  1. Scan the QR code.
  2. Decide what personal details to share.
  3. Sign in to your GitLab installation.
• Does not have the app installed, they are prompted to download the app and then follow the procedure above.

If everything works, the user is returned to GitLab and is signed in.