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:
- Navigate to your GitHub organization settings
- Go to Developer settings ā GitHub Apps
- 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:
- Go to the Idsync dashboard
- Navigate to Integrations ā Add Integration
- Select GitHub from the provider list
- 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:
- Configure your backup storage
- Set up automated snapshots