6.0 KiB
title, shortTitle, intro, permissions, versions, type, topics, redirect_from
| title | shortTitle | intro | permissions | versions | type | topics | redirect_from | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Configuring authentication and provisioning with Entra ID | Set up Entra ID | You can use a tenant in Microsoft Entra ID (previously known as Azure AD) as an identity provider (IdP) to centrally manage authentication and user provisioning for {% data variables.location.product_location %}. | Site administrators with admin access to the IdP |
|
how_to |
|
|
{% data reusables.scim.ghes-beta-note %}
About authentication and user provisioning with Entra ID
Entra ID is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see What is Microsoft Entra ID? in the Microsoft Docs.
{% data reusables.saml.idp-saml-and-scim-explanation %}
For more information, see AUTOTITLE.
Prerequisites
The general prerequisites for using SCIM on {% data variables.product.prodname_ghe_server %} apply. See the "Prerequisites" section in AUTOTITLE.
In addition:
-
To configure SCIM, you must have completed steps 1 to 4 in AUTOTITLE.
- You will need the {% data variables.product.pat_v1 %} created for the setup user to authenticate requests from Entra ID.
-
To configure authentication and user provisioning using Entra ID, you must have an Entra ID account and tenant. For more information, see the Entra ID website and Quickstart: Set up a tenant in the Microsoft Docs.
1. Configure SAML
[!NOTE] Even if you have previously configured SAML on Entra ID, you will need to configure SAML and SCIM on a new application to enable SCIM provisioning.
Before starting this section, ensure you have followed steps 1 and 2 in AUTOTITLE.
In Entra ID
-
Create the "{% data variables.product.prodname_ghe_server %}" application in Entra ID. For instructions, see the "Adding {% data variables.product.prodname_ghe_server %} from the gallery" section in Microsoft's guide Tutorial: Microsoft Entra SSO integration with GitHub Enterprise Server.
[!NOTE] Do not use the application labeled "(Legacy)."
-
In the "{% data variables.product.prodname_ghe_server %}" application settings, click Single sign-on in the left sidebar, then click SAML.
-
In the "Basic SAML Configuration" section, click Edit, then add the following details.
- "Identifier": your {% data variables.product.prodname_ghe_server %} host URL (
https://HOSTNAME.com) - "Reply URL": your host URL, followed by
/saml/consume(https://HOSTNAME.com/saml/consume)
- "Identifier": your {% data variables.product.prodname_ghe_server %} host URL (
-
In the "SAML certificates" section, download the SAML certificate (Base64).
-
In the "Set up {% data variables.product.prodname_ghe_server %}" section, make a note of the Login URL and Microsoft Entra Identifier.
On {% data variables.product.prodname_ghe_server %}
- Sign in to {% data variables.product.prodname_ghe_server %} as a user with access to the Management Console.
- Configure SAML using the information you have gathered. See AUTOTITLE.
2. Configure SCIM
Before starting this section, ensure you have followed steps 1 to 4 in AUTOTITLE.
-
In the "{% data variables.product.prodname_ghe_server %}" application in Entra ID, click Provisioning in the left sidebar, then click Get started.
-
Select the "Automatic" provisioning mode.
-
In the "Admin Credentials" section, add the following details.
- "Tenant URL": your {% data variables.product.prodname_ghe_server %} host URL, followed by
/api/v3/scim/v2(https://HOSTNAME.com/api/v3/scim/v2) - "Secret Token": the {% data variables.product.pat_v1 %} created for the setup user
- "Tenant URL": your {% data variables.product.prodname_ghe_server %} host URL, followed by
-
Click Test Connection.
-
When the test is complete, click Save.
-
Navigate back to the "Overview" page.
-
To provision your EntraID users to your {% data variables.product.prodname_ghe_server %} appliance, Click Start provisioning.
When you have finished configuring SCIM, you may want to disable some SAML settings you enabled for the configuration process. See AUTOTITLE.