Article version: Enterprise Server 2.17
SAML is an XML-based standard for authentication and authorization. GitHub Enterprise Server can act as a service provider (SP) with your internal SAML identity provider (IdP).
If you want to authenticate users without adding them to your identity provider, you can configure built-in authentication. For more information, see "Allowing built-in authentication for users outside your identity provider."
We offer limited support for all identity providers that implement the SAML 2.0 standard. We officially support these identity providers that have been internally tested:
- Active Directory Federation Services (AD FS)
- Azure Active Directory (Azure AD)
GitHub Enterprise does not support SAML Single Logout. To terminate an active SAML session, users should log out directly on your SAML IdP.
Each GitHub Enterprise Server username is determined by one of the following assertions in the SAML response, ordered by priority:
- The custom username attribute, if defined and present
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameassertion, if present
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddressassertion, if present
NameID element is required even if other attributes are present.
A mapping is created between the
NameID and the GitHub Enterprise Server username, so the
NameID should be persistent, unique, and not subject to change for the lifecyle of the user.
GitHub Enterprise Server usernames can only contain alphanumeric characters and dashes (
-). GitHub Enterprise Server will normalize any non-alphanumeric character in your account's username into a dash. For example, a username of
gregory.st.john will be normalized to
gregory-st-john. Note that normalized usernames also can't start or end with a dash. They also can't contain two consecutive dashes.
Usernames created from email addresses are created from the normalized characters that precede the
If multiple accounts are normalized into the same GitHub Enterprise Server username, only the first user account is created. Subsequent users with the same username won't be able to sign in.
This table gives examples of how usernames are normalized in GitHub Enterprise Server:
|Ms.Bubbles||This username is created successfully.|
|!Ms.Bubbles||This username is not created, because it starts with a dash.|
|Ms.Bubbles!||This username is not created, because it ends with a dash.|
|Ms!!Bubbles||This username is not created, because it contains two consecutive dashes.|
|Ms!Bubbles||This username is not created. Although the normalized username is valid, it already exists.|
|Ms.Bubbles@example.com||This username is not created. Although the normalized username is valid, it already exists.|
When using SAML or CAS, two-factor authentication is not supported or managed on the GitHub Enterprise Server appliance, but may be supported by the external authentication provider. Two-factor authentication enforcement on organizations is not available. For more information about enforcing two-factor authentication on organizations, see "Requiring two-factor authentication in your organization."
Your GitHub Enterprise Server instances's service provider metadata is available at
To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is
http(s)://[hostname]/saml/consume. It uses the
These attributes are available. You can change the attribute names in the management console, with the exception of the
|Default attribute name||Type||Description|
|Required||A persistent user identifier. Any persistent name identifier format may be used. The |
|Optional||When the value is 'true', the user will automatically be promoted as an administrator. Any other value or a non-existent value will demote the user to a normal user account.|
|Optional||The GitHub Enterprise Server username.|
|Optional||The name of the user displayed on their profile page. Users may change their names after provisioning.|
|Optional||The email addresses for the user. More than one can be specified.|
|Optional||The public SSH keys for the user. More than one can be specified.|
|Optional||The GPG keys for the user. More than one can be specified.|
In the upper-right corner of any page, click .
In the left sidebar, click Management Console.
In the left sidebar, click Authentication.
Optionally, select Allow built-in authentication to invite users to use built-in authentication if they don’t belong to your GitHub Enterprise Server instance's identity provider.
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
AuthnRequestback 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 Support.
Select Disable administrator demotion/promotion if you do not want your SAML provider to determine administrator rights for users on your GitHub Enterprise Server instance.
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 your GitHub Enterprise Server instance to use internal nameservers.
Optionally, in the Issuer field, type your SAML issuer's name. This verifies the authenticity of messages sent to your GitHub Enterprise Server instance.
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 your GitHub Enterprise Server instance. Specify the format with the Name Identifier Format drop-down menu.
Under Verification certificate, click Choose File and choose a certificate to validate SAML responses from the IdP.
Modify the SAML attribute names to match your IdP if needed, or accept the default names.
If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "Suspending and unsuspending users".
The response message must fulfill the following requirements:
<Destination>element must be provided on the root response document and match the ACS URL only when the root response document is signed. If the assertion is signed, it will be ignored.
<Audience>element must always be provided as part of the
<AudienceRestriction>element. It must match the GitHub Enterprise Server Entity Id. This is the URL to the GitHub Enterprise Server instance, such as
- Each assertion in the response must be protected by a digital signature. This can be accomplished by signing each individual
<Assertion>element or by signing the
<NameID>element must be provided as part of the
<Subject>element. Any persistent name identifier format may be used.
Recipientattribute must be present and set to the ACS URL. For example:
<samlp:Response ...> <saml:Assertion ...> <saml:Subject> <saml:NameID ...>...</saml:NameID> <saml:SubjectConfirmation ...> <saml:SubjectConfirmationData Recipient="https://ghe.corp.example.com/saml/consume" .../> </saml:SubjectConfirmation> </saml:Subject> <saml:AttributeStatement> <saml:Attribute FriendlyName="USERNAME-ATTRIBUTE" ...> <saml:AttributeValue>monalisa</saml:AttributeValue> </saml:Attribute> </saml:AttributeStatement> </saml:Assertion> </samlp:Response>
Recipient does not match the ACS URL, the following error message will be present in the auth log:
Recipient in the SAML response was not valid.
Recipient is not part of the response message, the following error message will be present in the auth log:
Recipient in the SAML response must not be blank.
If the SAML response is not signed, or the signature does not match the contents, the following error message will be present in the auth log:
SAML Response is not signed or has been modified.
Audience is missing or does not match the GitHub Enterprise Server Entity Id, the following error message will be present in the auth log:
Audience is invalid. Audience attribute does not match your_instance_url