Skip to content

Commit dd524ff

Browse files
Make "About Enterprise Managed Users" scannable (#50406)
Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com>
1 parent b5ad325 commit dd524ff

File tree

14 files changed

+152
-134
lines changed

14 files changed

+152
-134
lines changed

content/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/managing-team-memberships-with-identity-provider-groups.md

+9
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,12 @@ Enterprise owners can review a list of IdP groups, each group's memberships, and
9595
1. To view the teams connected to the IdP group, click **Teams**.
9696

9797
If a team cannot sync with the group on your IdP, the team will display an error. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/troubleshooting-team-membership-with-identity-provider-groups)."
98+
99+
## Removing members from organizations
100+
101+
The way a member is added to an organization owned by your enterprise determines how they must be removed from an organization.
102+
103+
- **If a member was added to an organization manually, you must remove them manually.** Unassigning them from the {% data variables.product.prodname_emu_idp_application %} application on your IdP will suspend the user but not remove them from the organization.
104+
- **If a user became an organization member because they were added to IdP groups, remove them from _all_ of the mapped IdP groups** associated with the organization.
105+
106+
To discover how a member was added to an organization, you can filter the member list by type. See "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#filtering-by-member-type-in-an-enterprise-with-managed-users)."

content/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-and-groups-with-scim-using-the-rest-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ When you configure authentication and provisioning for your enterprise, you can
4040

4141
### Using a partner identity provider
4242

43-
Each partner IdP provides a "paved-path" application, which implements both SSO and user lifecycle management. To simplify your configuration of {% data variables.product.prodname_emus %}, {% data variables.product.company_short %} recommends that you use a partner IdP's application for both authentication and provisioning. For more information and a list of partner IdPs, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users#about-authentication-and-user-provisioning)."
43+
Each partner IdP provides a "paved-path" application, which implements both SSO and user lifecycle management. To simplify your configuration of {% data variables.product.prodname_emus %}, {% data variables.product.company_short %} recommends that you use a partner IdP's application for both authentication and provisioning. For more information and a list of partner IdPs, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users#identity-management-systems)."
4444

4545
When you use a single partner IdP for both authentication and provisioning, {% data variables.product.company_short %} provides support for the application on the partner IdP, as well as the IdPs' integration with {% data variables.product.product_name %}.
4646

content/admin/identity-and-access-management/reconfiguring-iam-for-enterprise-managed-users/migrating-your-enterprise-to-a-new-identity-provider-or-tenant.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ If you don't already have single sign-on recovery codes for your enterprise, dow
7070

7171
### 4. Disable authentication and provisioning for your enterprise
7272

73-
1. Use a recovery code to sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user, whose username is your enterprise's shortcode suffixed with `_admin`. For more information about the setup user, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#getting-started-with-enterprise-managed-users)."
73+
1. Use a recovery code to sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user, whose username is your enterprise's shortcode suffixed with `_admin`. For more information about the setup user, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/getting-started-with-enterprise-managed-users)."
7474
1. Disable authentication and provisioning for your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users/disabling-authentication-for-enterprise-managed-users#disabling-authentication)."
7575
1. Wait up to an hour for {% data variables.product.product_name %} to reset your enterprise's SCIM records and suspend your enterprise's members.
7676

content/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users.md

+33-122
Large diffs are not rendered by default.

content/admin/identity-and-access-management/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If you choose {% data variables.product.prodname_emus %} but require that users
6565

6666
## Can your enterprise tolerate migration costs?
6767

68-
If you already have an enterprise that uses personal accounts on {% data variables.product.prodname_dotcom_the_website %}, adoption of {% data variables.product.prodname_emus %} requires migration to a new enterprise account. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#getting-started-with-enterprise-managed-users)."
68+
If you already have an enterprise that uses personal accounts on {% data variables.product.prodname_dotcom_the_website %}, adoption of {% data variables.product.prodname_emus %} requires migration to a new enterprise account. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/getting-started-with-enterprise-managed-users)."
6969

7070
Although {% data variables.product.prodname_emus %} does not differ in cost from an enterprise that uses personal accounts, the migration process may require time or cost from your team. Confirm that this migration process is acceptable to your business and your users. If not, an enterprise with personal accounts may be the better choice for you.
7171

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: 'Getting started with {% data variables.product.prodname_emus %}'
3+
shortTitle: Get started with managed users
4+
intro: 'Learn how to create and configure an {% data variables.enterprise.prodname_emu_enterprise %}.'
5+
product: '{% data reusables.gated-features.emus %}'
6+
versions:
7+
ghec: '*'
8+
type: overview
9+
topics:
10+
- Accounts
11+
- Authentication
12+
- Enterprise
13+
- SSO
14+
allowTitleToDifferFromFilename: true
15+
---
16+
17+
Before your developers can use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_emus %}, you must follow a series of configuration steps.
18+
19+
## Create a new enterprise account
20+
21+
To use {% data variables.product.prodname_emus %}, you need a **separate type of enterprise account** with {% data variables.product.prodname_emus %} enabled.
22+
23+
To request a new enterprise account, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). You'll discuss options for trialing {% data variables.product.prodname_emus %} or migrating from an existing enterprise.
24+
25+
When you're ready, your contact on the {% data variables.product.prodname_dotcom %} Sales team will create your new {% data variables.enterprise.prodname_emu_enterprise %}. You'll be asked to provide the following information:
26+
27+
- The **email address** for the user who will set up your enterprise.
28+
- A **short code** that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %}
29+
30+
## Create the setup user
31+
32+
After we create your enterprise, you will receive an email inviting you to choose a password for the setup user, which is used to configure authentication and provisioning. The username is your enterprise's shortcode suffixed with `_admin`, for example `fabrikam_admin`.
33+
34+
Using an **incognito or private browsing window**:
35+
36+
1. Set the user's password.
37+
1. Save the user's recovery codes.
38+
1. Enable two-factor authentication. See "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)."
39+
40+
{% data reusables.enterprise-accounts.emu-password-reset-session %}
41+
42+
## Configure authentication
43+
44+
Next, configure how your members will authenticate.
45+
46+
**If you're using Entra ID** as your IdP, you can choose between OpenID Connect (OIDC) and Security Assertion Markup Language (SAML).
47+
- We recommend OIDC, which includes support for Conditional Access Policies (CAP).
48+
- If you require multiple enterprises provisioned from one tenant, you must use SAML for each enterprise after the first.
49+
50+
**If you're using another IdP**, like Okta or PingFederate, you must use SAML to authenticate your members.
51+
52+
To get started, read the guide for your chosen authentication method.
53+
54+
- "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)"
55+
- "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)"
56+
57+
## Configure provisioning
58+
59+
After you configure authentication, you can configure SCIM provisioning, which is how your IdP will create {% data variables.enterprise.prodname_managed_users %} on {% data variables.product.prodname_dotcom %}. See "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users)."
60+
61+
## Manage organization membership
62+
63+
After authentication and provisioning are configured, you can start managing organization membership for your {% data variables.enterprise.prodname_managed_users %} by synchronizing IdP groups with teams. See "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)."
64+
65+
## Support developers with multiple user accounts
66+
67+
Developers may need to maintain separate, personal accounts for their work outside of your {% data variables.enterprise.prodname_emu_enterprise %}. You can help them manage multiple accounts by providing the following resources:
68+
69+
- **On the command line**, developers can configure Git to simplify the process of using multiple accounts. See "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts)."
70+
- **In the web interface**, developers can switch between accounts without always needing to re-authenticate. See "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/switching-between-accounts)."

content/admin/identity-and-access-management/understanding-iam-for-enterprises/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ children:
2929
- /about-enterprise-managed-users
3030
- /abilities-and-restrictions-of-managed-user-accounts
3131
- /choosing-an-enterprise-type-for-github-enterprise-cloud
32+
- /getting-started-with-enterprise-managed-users
3233
- /changing-authentication-methods
3334
- /allowing-built-in-authentication-for-users-outside-your-provider
3435
- /troubleshooting-identity-and-access-management-for-your-enterprise
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 'Authenticating with {% data variables.product.prodname_emus %}'
3+
shortTitle: Authenticate as a managed user
4+
intro: 'Learn how to authenticate to access an {% data variables.enterprise.prodname_emu_enterprise %} on {% data variables.product.prodname_dotcom %}.'
5+
product: '{% data reusables.gated-features.emus %}'
6+
versions:
7+
ghec: '*'
8+
topics:
9+
- Accounts
10+
- Authentication
11+
- Enterprise
12+
- SSO
13+
allowTitleToDifferFromFilename: true
14+
---
15+
16+
If you use a {% data variables.enterprise.prodname_managed_user %}, you must authenticate through your identity provider (IdP) to access {% data variables.product.prodname_dotcom %}. The location where you can authenticate depends on whether your enterprise uses SAML or OIDC authentication.
17+
18+
## Supported authentication locations
19+
20+
Authentication location | SAML | OIDC
21+
--- | --- | --- |
22+
IdP application portal | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %}
23+
Login page on {% data variables.product.prodname_dotcom %} |{% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %}
24+
The profile page for an organization or enterprise on {% data variables.product.prodname_dotcom %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %}
25+
26+
## Authenticating via the login page
27+
28+
1. Navigate to [https://github.com/login](https://github.com/login).
29+
1. In the "Username or email address" text box, enter your username including the underscore and short code.
30+
1. To continue to your IdP, click **Sign in with your identity provider**.

content/authentication/authenticating-with-saml-single-sign-on/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ versions:
1010
topics:
1111
- SSO
1212
children:
13+
- /authenticating-with-a-managed-user-account
1314
- /about-authentication-with-saml-single-sign-on
1415
- /authorizing-an-ssh-key-for-use-with-saml-single-sign-on
1516
- /authorizing-a-personal-access-token-for-use-with-saml-single-sign-on

content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ With {% data variables.product.prodname_emus %}, access and identity is managed
7878

7979
#### 1. Enabling SAML single sign-on and provisioning in your {% data variables.enterprise.prodname_emu_enterprise %}
8080

81-
In an {% data variables.enterprise.prodname_emu_enterprise %}, all members are provisioned and managed by your identity provider. You must enable SSO and SCIM provisioning before you can start using your enterprise. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users#getting-started-with-enterprise-managed-users)."
81+
In an {% data variables.enterprise.prodname_emu_enterprise %}, all members are provisioned and managed by your identity provider. You must enable SSO and SCIM provisioning before you can start using your enterprise. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/understanding-iam-for-enterprises/getting-started-with-enterprise-managed-users)."
8282

8383
#### 2. Managing organization and team membership in your {% data variables.enterprise.prodname_emu_enterprise %} with your identity provider
8484

Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
{% note %}
2-
3-
**Note:** Because {% data variables.product.prodname_dotcom %} adds an underscore and short code to the normalized identifier provided by your IdP when creating each username, conflicts can only occur within each {% data variables.enterprise.prodname_emu_enterprise %}. {% data variables.enterprise.prodname_managed_users_caps %} can share IdP identifiers or email addresses with other user accounts on {% data variables.product.prodname_dotcom %} that are outside the enterprise.
4-
5-
{% endnote %}
1+
> [!NOTE] Conflicts can only occur between users within the same enterprise. {% data variables.enterprise.prodname_managed_users_caps %} can share IdP identifiers or email addresses with other user accounts on {% data variables.product.prodname_dotcom_the_website %} that are outside the enterprise.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% data variables.product.company_short %} partners with some developers of identity management systems to provide a "paved-path" integration with {% data variables.product.prodname_emus %}. To simplify your configuration and ensure full support, {% data variables.product.company_short %} recommends that you use a single partner IdP for both authentication and provisioning.
1+
{% data variables.product.company_short %} partners with some developers of identity management systems to provide a "paved-path" integration with {% data variables.product.prodname_emus %}. To simplify your configuration and ensure full support, **use a single partner IdP for both authentication and provisioning.**

data/reusables/gated-features/emus.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% data variables.product.prodname_emus %} is available for new enterprise accounts on {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)."
1+
{% data variables.product.prodname_emus %} is available for new enterprise accounts on {% data variables.product.prodname_ghe_cloud %}. See "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)."
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Support for provisioning users with {% data variables.product.company_short %}'s public SCIM schema is in public beta and subject to change.
1+
Provisioning users with {% data variables.product.company_short %}'s public SCIM schema is in public beta and subject to change.

0 commit comments

Comments
 (0)