Configuring SAML single sign-on for your enterprise

About SAML SSO

SAML SSO allows you to centrally control and secure access to 您的 GitHub Enterprise Server 实例 from your SAML IdP. When an unauthenticated user visits 您的 GitHub Enterprise Server 实例 in a browser, GitHub Enterprise Server will redirect the user to your SAML IdP to authenticate. After the user successfully authenticates with an account on the IdP, the IdP redirects the user back to 您的 GitHub Enterprise Server 实例. GitHub Enterprise Server validates the response from your IdP, then grants access to the user.

After a user successfully authenticates on your IdP, the user's SAML session for 您的 GitHub Enterprise Server 实例 is active in the browser for 24 hours. After 24 hours, the user must authenticate again with your IdP.

If you remove a user from your IdP, you must also manually suspend them. Otherwise, the account's owner can continue to authenticate using access tokens or SSH keys. 更多信息请参阅“挂起和取消挂起用户”。

Supported identity providers

GitHub Enterprise Server 支持 SAML SSO 与采用 SAML 2.0 � �准的 IdP 一起使用。 更多信息请参阅 OASIS 网站上的 SAML Wiki。

GitHub 正式支持并在内部测试以下 IdP。

• Active Directory Federation Services (AD FS)
• Azure Active Directory (Azure AD)
• Okta
• OneLogin
• PingOne
• Shibboleth

Configuring SAML SSO

You can enable or disable SAML authentication for 您的 GitHub Enterprise Server 实例, or you can edit an existing configuration. You can view and edit authentication settings for GitHub Enterprise Server in the management console. For more information, see "Accessing the management console."

1. 从 GitHub Enterprise Server 上的管理帐户中，在任何页面的右上角，单击 。

   

2. 如果您尚未进入“站点管理员”页面，请在左上角单击 Site admin（站点管理员）。

   

3. 在左侧边� �中，单击 管理控制台。

4. 在左侧边� �中，单击 Authentication（身份验证）。

5. Select SAML.

   

6. （可选）若要允许在外部身份验证系统上没有帐户的用户使用内置身份验证登录，请选择 Allow built-in authentication（允许内置身份验证）。 更多信息请参阅“允许对提供程序覆盖范围以外的用户进行内置身份验证”。

   

7. Optionally, to enable unsolicited response SSO, select IdP initiated SSO. By default, GitHub Enterprise Server will reply to an unsolicited Identity Provider (IdP) initiated request with an AuthnRequest back to the IdP.

   

   Note: We recommend keeping this value unselected. You should enable this feature only in the rare instance that your SAML implementation does not support service provider initiated SSO, and when advised by GitHub Enterprise 支持.

8. Select Disable administrator demotion/promotion if you do not want your SAML provider to determine administrator rights for users on 您的 GitHub Enterprise Server 实例.

   

9. In the Single sign-on URL field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to configure 您的 GitHub Enterprise Server 实例 to use internal nameservers.

   

10. Optionally, in the Issuer field, type your SAML issuer's name. This verifies the authenticity of messages sent to 您的 GitHub Enterprise Server 实例.

    

11. In the Signature Method and Digest Method drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from 您的 GitHub Enterprise Server 实例. Specify the format with the Name Identifier Format drop-down menu.

    

12. Under Verification certificate, click Choose File and choose a certificate to validate SAML responses from the IdP.

    

13. Modify the SAML attribute names to match your IdP if needed, or accept the default names.

    

Further reading

• "Promoting or demoting a site administrator"