Skip to content

Commit b509a21

Browse files
authored
pull base content,head:MicrosoftDocs:main,into:wwlpublishsync
2 parents 8e326a4 + 5a4200b commit b509a21

13 files changed

+22
-20
lines changed

learn-pr/github/authenticate-authorize-user-identities-github/1-introduction.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Introduction
44
metadata:
55
title: Introduction
66
description: Learn how to manage the authentication and authorization of user identities on GitHub.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit

learn-pr/github/authenticate-authorize-user-identities-github/2-user-identity-access-management.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: User identity and access management
44
metadata:
55
title: User identity and access management
66
description: Learn how to manage the authentication and authorization of user identities on GitHub.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit

learn-pr/github/authenticate-authorize-user-identities-github/3-authentication.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: User authentication
44
metadata:
55
title: User authentication
66
description: Learn the different ways to authenticate a user in GitHub.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit

learn-pr/github/authenticate-authorize-user-identities-github/4-authorization.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: User authorization
44
metadata:
55
title: User authorization
66
description: Learn the different ways to authorize a user in GitHub.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit

learn-pr/github/authenticate-authorize-user-identities-github/5-team-synchronization.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Team synchronization
44
metadata:
55
title: Team synchronization
66
description: Learn about the team synchronization feature within GitHub.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit

learn-pr/github/authenticate-authorize-user-identities-github/6-knowledge-check.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Module assessment
44
metadata:
55
title: Module assessment
66
description: Review what you learned.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit
@@ -60,4 +60,4 @@ quiz:
6060
explanation: "This form of 2FA relies on the assumption that the user is the only person with access to their mobile device."
6161
- content: "Security Key"
6262
isCorrect: false
63-
explanation: "A user can register a new security key through accessing their profile settings and following the security keys documentation."
63+
explanation: "A user can register a new security key through accessing their profile settings and following the security key's documentation."

learn-pr/github/authenticate-authorize-user-identities-github/7-summary.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Summary
44
metadata:
55
title: Summary
66
description: Recap the content taught in this module.
7-
ms.date: 04/09/2024
7+
ms.date: 04/09/2025
88
author: a-a-ron
99
ms.author: aastewar
1010
ms.topic: unit

learn-pr/github/authenticate-authorize-user-identities-github/includes/3-authentication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
Here, you'll learn about two recommended authentication systems GitHub Enterprises employ. You'll also learn how to do a basic but important 2FA audit for user compliance.
1+
Here, you'll learn about two recommended authentication systems GitHub Enterprises employ. You'll also learn how to do a basicbut important2FA audit for user compliance.
22

33
When it comes to user authentication, security should be the number one consideration that comes to mind. Strong security is essential. It seems like every month or so, a company reports a data breach. Credentials are stolen because of inefficient security processes, or simply because of a lack of up-to-date security features within the company. Establishing secure user authentication can be a difficult task if user adoption requires long and frustrating steps to authenticate. Ask any security professional and they'll mention several ways that companies authenticate their users.
44

55
There are two recommended authentication methods you can implement when authenticating your users on GitHub: SAML SSO and multifactor authentication, also known as 2FA or MFA.
66

77
## Authentication with SAML SSO
88

9-
SAML authentication is a process used to verify user identity and credentials against a known identity provider. Nowadays, your company might likely already be using this form of authentication. If so, you can link your existing IdP to GitHub for user sign-in management. The following is a high-level overview of the process that occurs with enabled SAML SSO within your GitHub Enterprise:
9+
SAML authentication is a process used to verify user identity and credentials against a known identity provider. Nowadays, your company might already be using this form of authentication. If so, you can link your existing IdP to GitHub for user sign-in management. The following is a high-level overview of the process that occurs with enabled SAML SSO within your GitHub Enterprise:
1010

1111
- Before enabling SAML SSO with your GitHub Enterprise, an Administrator needs to connect the GitHub organization to a supported IdP.
1212
- Next, when a member accesses resources within an organization that uses SAML SSO, GitHub redirects the member to the IdP to authenticate.
1313
- After successful authentication, the IdP redirects the member back to GitHub, where the member can access the organization's resources. The result means that even after configuring SAML SSO, the GitHub organization's members will continue to be prompted to log into their user accounts on GitHub.
1414

1515
### Enforce SAML SSO for your organization
1616

17-
It's important to note that if you have enabled SAML SSO across your organization, you'll need to enforce authentication after the setting has been enabled. This enforcement makes the authentication process a requirement. As the organization administrator, you can enforce this setting by selecting **Your organizations**, then selecting **Settings**, then choosing **Organization security**. Under SAML single sign-on, select **Require SAML SSO authentication for all members of the organization**.
17+
It's important to note that if you have enabled SAML SSO across your organization, you'll need to enforce authentication after the setting has been enabled. This enforcement makes the authentication process a requirement. As the organization administrator, you can enforce this setting by selecting **Your organizations**, then selecting **Settings**, then choosing **Authentication security**. Under SAML single sign-on, select **Require SAML SSO authentication for all members of the organization**.
1818

1919
:::image type="content" source="../media/require-saml-sso-authentication.png" alt-text="Screenshot of the setting to require SSO authentication for all members of an organization." :::
2020

learn-pr/github/authenticate-authorize-user-identities-github/includes/4-authorization.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ SCIM is a protocol that tells the directory an account has been created and allo
1313
> [!NOTE]
1414
> If you use SAML SSO without implementing SCIM, you won't have automatic deprovisioning.
1515
16-
SCIM integrations allow the secure exchange of user identity data between your IdP and your enterprise on GitHub. SCIM was developed to allow the synchronization of information between an IdP and multiple applications. When organization members' sessions expire after their access is removed from the IdP, they aren't automatically removed from the organization. Authorized tokens grant access to the organization even after their sessions expire. To remove this access, you can either manually remove the authorized token from the organization or automate its removal with SCIM.
16+
SCIM integrations allow the secure exchange of user identity data between your IdP and your enterprise on GitHub. SCIM was developed to allow synchronizing information between an IdP and multiple applications. When organization members' sessions expire after their access is removed from the IdP, they aren't automatically removed from the organization. Authorized tokens grant access to the organization even after their sessions expire. To remove this access, you can either manually remove the authorized token from the organization or automate its removal with SCIM.
1717

1818
### SSH key and PAT with SAML SSO
1919

@@ -23,9 +23,11 @@ To access your organization's protected resources using the API and Git on the c
2323

2424
:::image type="content" source="../media/saml-sso-ssh-key-example.png" alt-text="Screenshot of the SSH key." :::
2525

26-
After you enable SAML SSO, there are multiple ways you can add new members to your organization. Organization owners can invite new members manually on GitHub or by using the API. To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing *ORGANIZATION* with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can click a link on the IdP's dashboard to join your GitHub organization.
26+
After you enable SAML SSO, there are multiple ways you can add new members to your organization. Organization owners can invite new members manually on GitHub or by using the API. To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing *ORGANIZATION* with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can select a link on the IdP's dashboard to join your GitHub organization.
2727

28-
SCIM and SAML SSO also have security benefits. The first time a member uses SAML SSO to access your organization, GitHub automatically creates a record that links your organization, the member's GitHub account, and the member's account on your IdP. You can review the SAML SSO identity that a member has linked to their GitHub account. When available, the entry will include SCIM data for the user. You can also view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. When an employee leaves the company, the off-boarding process is automated, and deprovisioning happens automatically. When you unassign the application from a user or deactivate a user's account on your IdP, it will communicate with GitHub.com to invalidate any SAML sessions for that user. Automating these tasks reduces the time required for an administrator to manage user credentials and the risk of error associated with manually entering and updating user information is also mitigated.
28+
SCIM and SAML SSO also have security benefits. The first time a member uses SAML SSO to access your organization, GitHub automatically creates a record that links your organization, the member's GitHub account, and the member's account on your IdP. You can review the SAML SSO identity that a member has linked to their GitHub account. When available, the entry includes SCIM data for the user. You can also view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account.
29+
30+
When an employee leaves the company, the off-boarding process is automated, and deprovisioning happens automatically. When you unassign the application from a user or deactivate a user's account on your IdP, it will communicate with GitHub.com to invalidate any SAML sessions for that user. Automating these tasks reduces the time required for an administrator to manage user credentials and the risk of error associated with manually entering and updating user information is also mitigated.
2931

3032
### Connect your IdP to your organization
3133

@@ -41,7 +43,7 @@ If your support request is outside of the scope of what our team can help you wi
4143
- Hardware setup
4244
- CI/CD, such as Jenkins
4345
- Writing scripts
44-
- Configuration of external authentication systems, such as SAML identity providers
46+
- Configuring external authentication systems, such as SAML identity providers
4547
- Open-source projects
4648

4749
Some companies may have built their own system and synchronize their accounts in a custom way. GitHub doesn't support these custom-created accounts with technical assistance. Technical support by GitHub for changes in the way GitHub.com uses SCIM and SAML is available for enterprises that are using one of the providers listed previously.

learn-pr/github/authenticate-authorize-user-identities-github/includes/5-team-synchronization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can enable and use team synchronization, but only with the following support
3636

3737
The steps to enable team synchronization depend on the IdP you want to use. There are prerequisites to enable team synchronization that apply to each IdP. To enable team synchronization with your IdP, you must obtain administrative access or work with your IdP administrator to configure the IdP integration and groups. After you enable team synchronization, team maintainers and organization owners can connect a team to an IdP group on GitHub or through the API.
3838

39-
**Microsoft Entra ID**: The GitHub System Admin for the GitHub organization will need to identify and work with the Microsoft Entra Administrator to configure Team Synchronization. On the Microsoft Entra ID side, the service is called "automatic user account provisioning." To enable team synchronization for Microsoft Entra ID, the installation needs the following permissions:
39+
**Microsoft Entra ID**: The GitHub System Admin for the GitHub organization needs to identify and work with the Microsoft Entra Administrator to configure Team Synchronization. On the Microsoft Entra ID side, the service is called *automatic user account provisioning*. To enable team synchronization for Microsoft Entra ID, the installation needs the following permissions:
4040

4141
- Read all users’ full profiles
4242
- Sign in and read user profiles
@@ -50,6 +50,6 @@ The steps to enable team synchronization depend on the IdP you want to use. Ther
5050

5151
## Disable team synchronization
5252

53-
When you disable team synchronization, any team members who were assigned to a GitHub team through the IdP group are removed from the team and may lose access to your organization's repositories. You can disable this feature through the organization settings by selecting **Your organization** and selecting **Settings**. Next, select **Organization security** and choose **Disable team synchronization**.
53+
When you disable team synchronization, any team members who were assigned to a GitHub team through the IdP group are removed from the team and may lose access to your organization's repositories. You can disable this feature through the organization settings by selecting **Your organization** and selecting **Settings**. Next, select **Authentication security** and choose **Disable team synchronization**.
5454

5555
:::image type="content" source="../media/disable-team-synchronization.png" alt-text="Screenshot of the organization setting to disable team synchronization." :::

0 commit comments

Comments
 (0)