GitHub Team Sync

Overview

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.

Toggle ON GitHub Organization sync to activate sync.

Connecting the Hanzo KMS 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 Hanzo KMS oauth application to your configured organization. Hanzo KMS shown here is an organization, just for walkthrough.

This action only needs to be done once and authorizes the Hanzo KMS OAuth app to read organization details, including team information. The following users don't need to select organization in GitHub on login anymore.

Working

Manual Team Sync

To perform manual syncs, you'll need to create a GitHub Personal Access Token with the appropriate permissions. GitHub offers two types of tokens:

1. Go to GitHub Settings → Personal Access Tokens → Tokens (classic)
2. Click Generate new token → Generate new token (classic)
3. Give your token a descriptive name (e.g., "Hanzo KMS GitHub Sync")
4. Set an appropriate expiration date
5. Select the read:org scope - Required to read organization team information
6. Click Generate token
7. Copy the token immediately (you won't be able to see it again)

1. Go to GitHub Settings → Personal Access Tokens → Fine-grained tokens
2. Click Generate new token
3. Give your token a descriptive name (e.g., "Hanzo KMS GitHub Sync")
4. Set an appropriate expiration date
5. Select your organization under Resource owner
6. Under Organization permissions, set Members to Read
7. Click Generate token
8. Copy the token immediately (you won't be able to see it again)

1. Navigate to the Single Sign-On (SSO) page and select the Provisioning tab.
2. Click the Configure button next to your GitHub Organization configuration.
3. In the configuration modal, you'll find an optional GitHub Access Token field.
4. Paste the token you generated in the previous step.
5. Click Update to save the configuration.

Once you have configured the GitHub access token:

1. Navigate to the Single Sign-On (SSO) page and select the Provisioning tab.
2. You'll see a Sync Now section with a button to trigger the manual sync.
3. Click Sync Now to synchronize GitHub teams for all organization members.

The sync operation will process all organization members who have previously logged in with GitHub and update their team memberships accordingly.

Troubleshooting

If you encounter an error related to this, it indicates that you need to approve the Hanzo KMS 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.