Are you sure you want to delete this access key?
title | shortTitle | intro | permissions | product | versions | type | topics | redirect_from |
---|---|---|---|---|---|---|---|---|
Configuring user provisioning for your enterprise | Configuring user provisioning | You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on {% data variables.product.product_location %} when you assign the application for {% data variables.product.product_location %} to a user on your identity provider (IdP). | Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}. | {% data reusables.gated-features.saml-sso %} | [{github-ae *}] | how_to | [Accounts Authentication Enterprise Identity SSO] | [/admin/authentication/configuring-user-provisioning-for-your-enterprise] |
{% data reusables.saml.ae-uses-saml-sso %} For more information, see "Configuring SAML single sign-on for your enterprise."
{% data reusables.scim.after-you-configure-saml %} For more information about SCIM, see System for Cross-domain Identity Management: Protocol (RFC 7644) on the IETF website.
{% if currentVersion == "github-ae@latest" %}
Configuring provisioning allows your IdP to communicate with {% data variables.product.product_location %} when you assign or unassign the application for {% data variables.product.product_name %} to a user on your IdP. When you assign the application, your IdP will prompt {% data variables.product.product_location %} to create an account and send an onboarding email to the user. When you unassign the application, your IdP will communicate with {% data variables.product.product_name %} to invalidate any SAML sessions and disable the member's account.
To configure provisioning for your enterprise, you must enable provisioning on {% data variables.product.product_name %}, then install and configure a provisioning application on your IdP.
The provisioning application on your IdP communicates with {% data variables.product.product_name %} via our SCIM API for enterprises. For more information, see "GitHub Enterprise administration" in the {% data variables.product.prodname_dotcom %} REST API documentation.
{% endif %}
{% data reusables.scim.supported-idps %}
When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "Synchronizing a team with an identity provider group."
{% if currentVersion == "github-ae@latest" %}
To automatically provision and deprovision access to {% data variables.product.product_location %} from your IdP, you must first configure SAML SSO when you initialize {% data variables.product.product_name %}. For more information, see "Initializing {% data variables.product.prodname_ghe_managed %}."
You must have administrative access on your IdP to configure the application for user provisioning for {% data variables.product.product_name %}.
{% endif %}
{% if currentVersion == "github-ae@latest" %}
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 {% data variables.product.prodname_ghe_managed %}." - 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.
{% endnote %} {% warning %}
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.
{% endwarning %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %}
The following IdPs provide documentation about configuring provisioning for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}.
IdP | More information |
---|---|
Azure AD | Tutorial: Configure {% data variables.product.prodname_ghe_managed %} for automatic user provisioning in the Microsoft Docs |
The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.product.product_location %}.
Value | Other names | Description | Example |
---|---|---|---|
URL | Tenant URL | URL to the SCIM provisioning API for your enterprise on {% data variables.product.prodname_ghe_managed %} | https://api.YOUR-GITHUB-AE-HOSTNAME/scim/v2 |
Shared secret | Personal access token, secret token | Token for application on your IdP to perform provisioning tasks on behalf of an enterprise owner | Personal access token you created in step 1 |
{% endif %}
Press p or to see the previous file or, n or to see the next file
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?