mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
73 lines
4.0 KiB
Plaintext
73 lines
4.0 KiB
Plaintext
---
|
|
title: "GitHub Team Sync"
|
|
description: "Learn how to automatically synchronize your GitHub teams with Infisical Groups."
|
|
---
|
|
|
|
## Overview
|
|
|
|
The GitHub Organization Synchronization feature streamlines user and group management by automatically syncing users belonging to your specified GitHub organization with corresponding groups within Infisical. This integration ensures that users logging in via GitHub are automatically added to or removed from Infisical groups based on their team memberships within your GitHub organization.
|
|
|
|
## Configuration
|
|
|
|
To enable and configure GitHub Organization Synchronization, follow these steps:
|
|
|
|
<Steps>
|
|
<Step title="Set up GitHub organization configuration">
|
|
1. Navigate to the **Single Sign-On (SSO)** page and select the **Provisioning** tab.
|
|
|
|
2. Click the **Configure** button and provide the name of your GitHub Organization.
|
|
|
|
</Step>
|
|
<Step title="Enable GitHub organization sync">
|
|
Toggle ON GitHub Organization sync to activate sync.
|
|
|
|
</Step>
|
|
<Step title="Approve the Infisical OAuth application on your organization">
|
|
Connecting the Infisical OAuth application grants it permission to **read:org** details. This approval is done by selecting your organization during the GitHub OAuth login process.
|
|
|
|
1. Initiate the login process via the GitHub OAuth flow.
|
|
|
|
2. Select the organization you have connected.
|
|
3. Grant access to Infisical oauth application to your configured organization. Infisical shown here is an organization, just for walkthrough.
|
|
|
|
|
|
<Info>
|
|
This action only needs to be done once and authorizes the Infisical OAuth app to read organization details, including team information.
|
|
The following users don't need to select organization in GitHub on login anymore.
|
|
</Info>
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Working
|
|
|
|
Once configured, the GitHub Organization Synchronization feature functions as follows:
|
|
|
|
When a user logs in via the GitHub OAuth flow and selects the configured organization, the system will then automatically synchronize the teams they are a part of in GitHub with corresponding groups in Infisical.
|
|
|
|
## Manual Team Sync
|
|
|
|
You can manually synchronize GitHub teams for all organization members who have previously logged in with GitHub. This bulk sync operation updates team memberships without requiring users to log in again.
|
|
|
|
To trigger a manual sync, click the **Manually sync GitHub teams for all organization members** button:
|
|
|
|
|
|
|
|
If you don't have a GitHub token configured or your token has expired, a modal will appear prompting you to provide one:
|
|
|
|
|
|
|
|
<Info>
|
|
The token must be granted **read:org** and **read:user** permissions to successfully sync groups. This configuration is only required once - if you already have a valid token configured, the sync will proceed automatically.
|
|
</Info>
|
|
|
|
## Troubleshooting
|
|
|
|
<Accordion title="Please check if your organization has approved the Infisical OAuth application.">
|
|
If you encounter an error related to this, it indicates that you need to approve the Infisical OAuth application within your GitHub organization.
|
|
|
|
You can verify the application's approval status by navigating to **https://github.com/organizations/__your-organization__/settings/oauth_application_policy**. Replace `__your-organization__` with the actual name of your GitHub organization.
|
|
|
|
|
|
</Accordion>
|