Skip to main content

Configuring user provisioning for your enterprise

You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on Enterprise when you assign the application for Enterprise to a user on your identity provider (IdP).

Enterprise owners can configure user provisioning for an enterprise on GitHub AE.

About user provisioning for your enterprise

GitHub AEは、ユーザ認証にSAML SSOを使用します。 GitHub AEへのアクセスは、SAML 2.0標準をサポートするIdPから集中管理できます。 For more information, see "Configuring SAML single sign-on for your enterprise."

You can configure user provisioning with SCIM to automatically create or suspend user accounts and grant access for GitHub AE when you assign or unassign the application on your IdP. For more information about SCIM, see System for Cross-domain Identity Management: Protocol (RFC 7644) on the IETF website.

If you do not configure user provisioning with SCIM, your IdP will not communicate with GitHub AE automatically when you assign or unassign the application to a user. Without SCIM, GitHub AE creates a user account using SAML Just-in-Time (JIT) provisioning the first time someone navigates to GitHub AE and signs in by authenticating through your IdP.

Configuring provisioning allows your IdP to communicate with Enterprise when you assign or unassign the application for GitHub AE to a user on your IdP. When you assign the application, your IdP will prompt Enterprise to create an account and send an onboarding email to the user. When you unassign the application, your IdP will communicate with GitHub AE to invalidate any SAML sessions and disable the member's account.

To configure provisioning for your enterprise, you must enable provisioning on GitHub AE, then install and configure a provisioning application on your IdP.

The provisioning application on your IdP communicates with GitHub AE via our SCIM API for enterprises. For more information, see "GitHub Enterprise administration" in the GitHub REST API documentation.

Supported identity providers

The following IdPs are supported for SSO with GitHub AE:

Note: GitHub AE single sign-on (SSO) support for Okta is currently in beta.

IdPSAMLユーザプロビジョニングTeam mapping
Azure Active Directory (Azure AD)
OktaBetaBetaBeta

For IdPs that support team mapping, you can assign or unassign the application for GitHub AE to groups of users in your IdP. These groups are then available to organization owners and team maintainers in Enterprise to map to GitHub AE teams. For more information, see "Mapping Okta groups to teams."

Prerequisites

To automatically provision and deprovision access to Enterprise from your IdP, you must first configure SAML SSO when you initialize GitHub AE. For more information, see "Initializing GitHub AE."

You must have administrative access on your IdP to configure the application for user provisioning for GitHub AE.

Enabling user provisioning for your enterprise

  1. While signed into Enterprise as an enterprise owner, create a personal access token with admin:enterprise scope. For more information, see "Creating a personal access token."

    Notes:

    • To create the personal access token, we recommend using the account for the first enterprise owner that you created during initialization. For more information, see "Initializing GitHub AE."
    • You'll need this personal access token to configure the application for SCIM on your IdP. Store the token securely in a password manager until you need the token again later in these instructions.

    Warning: If the user account for the enterprise owner who creates the personal access token is deactivated or deprovisioned, your IdP will no longer provision and deprovision user accounts for your enterprise automatically. Another enterprise owner must create a new personal access token and reconfigure provisioning on the IdP.

  2. GitHub AEの右上で、プロフィール写真をクリックし、続いてEnterprise settings(Enterpriseの設定)をクリックしてください。 GitHub AEのプロフィール写真のドロップダウンメニュー内の"Enterprise settings"

  3. Enterpriseアカウントのサイドバーで、 Settings(設定)をクリックしてください。 Enterpriseアカウントサイドバー内の設定タブ

  4. 左のサイドバーでSecurity(セキュリティ)をクリックしてください。 Security tab in the enterprise account settings sidebar

  5. Under "SCIM User Provisioning", select Require SCIM user provisioning. Checkbox for "Require SCIM user provisioning" within enterprise security settings

  6. Click Save. Save button under "Require SCIM user provisioning" within enterprise security settings

  7. Configure user provisioning in the application for GitHub AE on your IdP.

    The following IdPs provide documentation about configuring provisioning for GitHub AE. If your IdP isn't listed, please contact your IdP to request support for GitHub AE.

    IdPMore information
    Azure ADTutorial: Configure GitHub AE for automatic user provisioning in the Microsoft Docs. To configure Azure AD for GitHub AE, see "Configuring authentication and provisioning for your enterprise using Azure AD."
    Okta(beta) To configure Okta for GitHub AE, see "Configuring authentication and provisioning for your enterprise using Okta."

    The application on your IdP requires two values to provision or deprovision user accounts on Enterprise.

    ValueOther namesDescriptionExample
    URLTenant URLURL to the SCIM provisioning API for your enterprise on GitHub AEhttps://[hostname]/api/v3/scim/v2
    Shared secretPersonal access token, secret tokenToken for application on your IdP to perform provisioning tasks on behalf of an enterprise ownerPersonal access token you created in step 1