IdsyncIdsync Docs

Documentation

GitLab Integration

December 30, 2024gitlabintegrationoauth

GitLab Integration#

Connect your GitLab instance or GitLab.com organization to Idsync.

Prerequisites#

  • GitLab group owner or maintainer access
  • Idsync account with appropriate permissions
  • GitLab Premium or Ultimate (for some features)

Integration Methods#

GitLab can be integrated in two ways:

Best for GitLab.com and self-hosted GitLab instances.

Option B: Personal Access Token#

Quick setup for testing, not recommended for production.

OAuth Application Setup#

Step 1: Create OAuth Application#

  1. Go to your GitLab group settings
  2. Navigate to Settings ā†’ Applications
  3. Create a new application with these settings:
yaml
Name: Idsync Backup
Redirect URI: https://app.idsync.io/auth/gitlab/callback
Confidential: Yes
Scopes:
  - read_api
  - read_user

Step 2: Configure in Idsync#

  1. Open Idsync dashboard
  2. Go to Integrations ā†’ Add Integration
  3. Select GitLab
  4. Choose OAuth Application
  5. Enter your credentials:
    • Application ID
    • Application Secret
    • GitLab URL (for self-hosted)

Personal Access Token Setup#

āš ļø Note: This method is only recommended for testing purposes.

Step 1: Generate Token#

  1. Go to GitLab ā†’ User Settings ā†’ Access Tokens
  2. Create a token with these scopes:
    • read_api
    • read_user

Step 2: Add to Idsync#

  1. In Idsync, select Personal Access Token method
  2. Paste your token
  3. Click Connect

Verify Connection#

Once connected, you should see:

āœ“ Connected to GitLab: gitlab.com/your-group
āœ“ API access verified
āœ“ User permissions confirmed

Self-Hosted GitLab#

For self-hosted GitLab instances, additional configuration may be required:

Network Configuration#

Ensure your GitLab instance is accessible from Idsync:

  • Whitelist Idsync IP ranges
  • Configure SSL certificates
  • Set up reverse proxy if needed

Version Requirements#

GitLab VersionSupport Status
15.0+āœ… Full support
14.xāœ… Supported
13.xāš ļø Limited
< 13.0āŒ Not supported

Troubleshooting#

Invalid Scope Error#

Ensure all required scopes are selected when creating your OAuth application.

SSL Certificate Error#

For self-hosted instances, verify:

  • Certificate is valid and not expired
  • Full certificate chain is installed
  • No mixed content issues

Next Steps#