IdsyncIdsync Docs

GitHub Integration

December 30, 2024githubintegrationoauth

GitHub Integration#

Connect your GitHub organization to Idsync for seamless identity provider management.

Prerequisites#

Before you begin, ensure you have:

  • GitHub organization owner or admin access
  • Idsync account with appropriate permissions

Step 1: Create GitHub App#

First, you'll need to create a GitHub App in your organization:

  1. Navigate to your GitHub organization settings
  2. Go to Developer settings → GitHub Apps
  3. Click New GitHub App

Required Permissions#

Configure the following permissions for your GitHub App:

Organization permissions:
  - Members: Read-only
  - Administration: Read-only

Repository permissions:
  - Contents: Read-only (optional)

Step 2: Configure Idsync#

Once your GitHub App is created:

  1. Go to the Idsync dashboard
  2. Navigate to Integrations → Add Integration
  3. Select GitHub from the provider list
  4. Enter your GitHub App credentials:
    • App ID
    • Installation ID
    • Private Key

Step 3: Verify Connection#

After configuration, Idsync will verify the connection:

bash
āœ“ Connected to GitHub organization: your-org āœ“ Permissions verified āœ“ Ready for backup

Troubleshooting#

Common Issues#

Connection Failed

If you see a connection error, verify:

  • GitHub App is installed on your organization
  • Private key is correct and not expired
  • Required permissions are granted

Permission Denied

Ensure your GitHub App has the required permissions listed above.

Next Steps#

After connecting GitHub:

  1. Configure your backup storage
  2. Set up automated snapshots