👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Learn more on the GitHub blog.

Managing team synchronization for your organization

You can enable and disable team synchronization between your identity provider (IdP) and your organization on GitHub.

Organization owners can manage team synchronization for an organization.

Team synchronization is available for organizations and enterprise accounts using GitHub Enterprise Cloud. For more information, see "GitHub's products."

In this article

Note: Team synchronization with Okta is currently in beta and subject to change.

About team synchronization

You can enable team synchronization between your IdP and GitHub to allow organization owners and team maintainers to connect teams in your organization with IdP groups.

When you synchronize a GitHub team with an IdP group, changes to the IdP group are reflected on GitHub automatically, reducing the need for manual updates and custom scripts. You can use an IdP with team synchronization to manage administrative tasks such as onboarding new members, granting new permissions for movements within an organization, and removing member access to the organization.

You can use team synchronization with supported IdPs.

  • Azure AD
  • Okta

After you enable team synchronization, team maintainers and organization owners can connect a team to an IdP group on GitHub or through the API. For more information, see "Synchronizing a team with an identity provider group" and "Team synchronization."

You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "Enforcing security settings in your enterprise account."

Enabling team synchronization

The steps to enable team synchronization depend on the IdP you want to use. There are prerequisites to enable team synchronization that apply to every IdP. Each individual IdP has additional prerequisites.

Prerequisites

To enable team synchronization with any IdP, you must obtain administrative access to your IdP or work with your IdP administrator to configure the IdP integration and groups. The person who configures your IdP integration and groups must have one of the required permissions.

IdPRequired permissions
Azure AD
  • Global administrator
  • Privileged Role administrator
Okta
  • Service user with read-only administrator permissions

You must enable SAML single sign-on for your organization and your supported IdP. For more information, see "Enforcing SAML single sign-on for your organization."

You must authenticate to your organization using SAML SSO and the supported IdP. For more information, see "Authenticating with SAML single sign-on."

Enabling team synchronization for Azure AD

To enable team synchronization for Azure AD, your Azure AD installation needs the following permissions:

  • Read all users’ full profiles
  • Sign in and read user profile
  • Read directory data
  1. In the top right corner of GitHub, click your profile photo, then click Your profile.

    Profile photo

  2. On the left side of your profile page, under "Organizations", click the icon for your organization.

    organization icons

  3. Under your organization name, click Settings.

    Organization settings button

  4. In the left sidebar, click Organization security.

    Organization security settings

  5. Confirm that SAML SSO is enabled. For more information, see "Managing SAML single sign-on for your organization."

  6. Under "Team synchronization", click Enable for Azure AD.

    Enable team synchronization button on security settings page

  7. To confirm team synchronization:

    • If you have IdP access, click Enable team synchronization. You'll be redirected to your identity provider's SAML SSO page and asked to select your account and review the requested permissions.
    • If you don't have IdP access, copy the IdP redirect link and share it with your IdP administrator to continue enabling team synchronization.
      Enable team synchronization redirect button
  8. Review the identity provider tenant information you want to connect to your organization, then click Approve.

    Pending request to enable team synchronization to a specific IdP tenant with option to approve or cancel request

Enabling team synchronization for Okta

To enable team synchronization for Okta, you or your IdP administrator must:

  1. In the top right corner of GitHub, click your profile photo, then click Your profile.

    Profile photo

  2. On the left side of your profile page, under "Organizations", click the icon for your organization.

    organization icons

  3. Under your organization name, click Settings.

    Organization settings button

  4. In the left sidebar, click Organization security.

    Organization security settings

  5. Confirm that SAML SSO is enabled. For more information, see "Managing SAML single sign-on for your organization."

  6. Under "Team synchronization", click Enable for Okta.

    Enable team synchronization for Okta button on security settings page

  7. Under your organization's name, type a valid SSWS token and the URL to your Okta instance.

    Enable team synchronization Okta organization form

  8. Review the identity provider tenant information you want to connect to your organization, then click Create.

    Enable team synchronization create button

Disabling team synchronization

Warning: When you disable team synchronization, any team members that were assigned to a GitHub team through the IdP group are removed from the team and may lose access to repositories.

  1. In the top right corner of GitHub, click your profile photo, then click Your profile.

    Profile photo

  2. On the left side of your profile page, under "Organizations", click the icon for your organization.

    organization icons

  3. Under your organization name, click Settings.

    Organization settings button

  4. In the left sidebar, click Organization security.

    Organization security settings

  5. Under "Team synchronization", click Disable team synchronization.

    Disable team synchronization

Ask a human

Can't find what you're looking for?

Contact us