GitLab

Ory Console

Follow these steps to add GitLab as a social sign-in provider to your project using the Ory Console:

1. Go to Authentication → Social Sign-In in the Ory Console.

2. Click the switch next to the GitLab logo to start the configuration.

3. Copy the Redirect URI and save it for later use.

4. Create a GitLab OAuth2 Application.

5. Paste the saved Redirect URI from Ory into the corresponding field in the Gitlab OAuth2 Application configuration.

6. Enable the relevant Scopes for the application, by ticking the relevant boxes in the GitLab form:

   • read_user
   • openid
   • profile
   • email

7. Click Save application on the GitLab form, which brings you to a summary of the registered application's properties.

8. On the summary page, copy the Secret field.

   caution

   Make sure to copy the Secret field on this summary page right away. This is the only opportunity you will get to copy the secret.

9. Copy the Secret from the registered application in GitLab to the Client Secret field in the Ory Console.

10. Copy the Application ID from the registered application in GitLab to the Client ID field in the form in the Ory Console.

11. In the Scopes field of the form in the Ory Console, add the following scopes:

    • read_user
    • openid
    • profile
    • email

12. In the Data Mapping field of the form in the Ory Console, add the following Jsonnet code snippet, which maps the desired claims to the Ory Identity schema:

local claims = {
  email_verified: false,
} + std.extVar('claims');
{
  identity: {
    traits: {
      // Allowing unverified email addresses enables account
      // enumeration attacks,  if the value is used for
      // verification or as a password login identifier.
      //
      // Therefore we only return the email if it (a) exists and (b) is marked verified
      // by GitLab.
      [if 'email' in claims && claims.email_verified then 'email' else null]: claims.email,
    },
  },
}

info

GitLab returns only the sub and sub_legacy claims in the id_token. Ory makes a request to GitLab's /oauth/userinfo API and adds the user info to std.extVar('claims').

danger

Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in Ory Network.

12. Click Save Configuration.

Ory CLI

Follow these steps to add GitLab as a social sign-in provider to your project using the Ory CLI:

1. Create a GitLab OAuth2 Application.

2. In the created app, set the redirect URI to:

   https://$PROJECT_SLUG.projects.oryapis.com/self-service/methods/oidc/callback/gitlab

3. Create a Jsonnet code snippet to map the desired claims to the Ory Identity schema.

   local claims = {
     email_verified: false,
   } + std.extVar('claims');
   {
     identity: {
       traits: {
         // Allowing unverified email addresses enables account
         // enumeration attacks,  if the value is used for
         // verification or as a password login identifier.
         //
         // Therefore we only return the email if it (a) exists and (b) is marked verified
         // by GitLab.
         [if 'email' in claims && claims.email_verified then 'email' else null]: claims.email,
       },
     },
   }
   info

   GitLab returns only the sub and sub_legacy claims in the id_token. Ory makes a request to GitLab's /oauth/userinfo API and adds the user info to std.extVar('claims').

   danger

   Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in Ory Network.

4. Encode the Jsonnet snippet with Base64 or host it under an URL accessible to Ory Network.

   cat your-data-mapping.jsonnet | base64

5. Download the Ory Identities config from your project and save it to a file:

   ## List all available projects
   ory list projects
   
   ## Get config
   ory get identity-config {project-id} --format yaml > identity-config.yaml

6. Add the social sign-in provider configuration to the downloaded config. Add the Jsonnet snippet with mappings as a Base64 string or provide an URL to the file.

   selfservice:
     methods:
       oidc:
         config:
           providers:
             - id: gitlab # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
               provider: gitlab
               client_id: .... # Replace this with the OAuth2 Client ID provided by GitLab
               client_secret: .... # Replace this with the OAuth2 Client Secret provided by GitLab
               mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
               # Alternatively, use an URL:
               # mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4
               scope:
                 - read_user
                 - openid
                 - profile
                 - email
         enabled: true

7. Update the Ory Identities configuration using the file you worked with:

   ory update identity-config {project-id} --file identity-config.yaml

Troubleshooting

When you add a social sign-in provider, you can encounter common problems such as:

• Redirect URI mismatch
• Redirect loops during registration
• Domain verification issues

To troubleshoot those issues, read Social sign-in troubleshooting.