Skip to content

Commit f552929

Browse files
authored
Merge pull request #21545 from github/repo-sync
repo sync
2 parents 46a36fa + 37dad71 commit f552929

File tree

7 files changed

+68
-4
lines changed

7 files changed

+68
-4
lines changed

content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ If you're experiencing problems while switching between different authentication
2727

2828
- "[Switching your SAML configuration from an organization to an enterprise account](/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)"
2929
- "[Migrating from SAML to OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)"
30+
- "[Migrating your enterprise to a new identity provider or tenant](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-your-enterprise-to-a-new-identity-provider-or-tenant)"
3031

3132
## Accessing your enterprise when SSO is not available
3233

content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ children:
2222
- /managing-team-memberships-with-identity-provider-groups
2323
- /about-support-for-your-idps-conditional-access-policy
2424
- /migrating-from-saml-to-oidc
25+
- /migrating-your-enterprise-to-a-new-identity-provider-or-tenant
2526
---
2627

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Migrating your enterprise to a new identity provider or tenant
3+
shortTitle: Migrate to new IdP or tenant
4+
intro: 'You can migrate your enterprise to a different identity provider (IdP) or Azure AD tenant.'
5+
product: '{% data reusables.gated-features.emus %}'
6+
versions:
7+
feature: idp-tenant-migration
8+
topics:
9+
- Access management
10+
- Accounts
11+
- Administrator
12+
- Authentication
13+
- Enterprise
14+
- SSO
15+
---
16+
17+
## About migrations between IdPs and tenants
18+
19+
While using {% data variables.product.prodname_emus %}, you may need to migrate your enterprise to a new IdP or Azure AD tenant. For example, you might be ready to migrate from a test environment to your production environment.
20+
21+
Before you migrate your {% data variables.enterprise.prodname_emu_enterprise %} to a new IdP or tenant, determine whether the values of the normalized SCIM `userName` attribute will remain the same for your {% data variables.enterprise.prodname_managed_users %} in the new environment. For more information about username normalization, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."
22+
23+
If the normalized SCIM `userName` values will remain the same after the migration, you can complete the migration by yourself. For instructions, see "[Migrating when the normalized SCIM `userName` values will remain the same](#migrating-when-the-normalized-scim-username-values-will-remain-the-same)."
24+
25+
If the normalized SCIM `userName` values will change after the migration, {% data variables.product.company_short %} will need to help with your migration. For more information, see "[Migrating when the normalized SCIM `userName` values will change](#migrating-when-the-normalized-scim-username-values-will-change)."
26+
27+
## Migrating when the normalized SCIM `userName` values will remain the same
28+
29+
To migrate to a new IdP or tenant, you cannot edit your existing SAML configuration. Instead, you must completely deactivate SAML for your enterprise account, then create new SAML and SCIM configurations for the new IdP or tenant.
30+
31+
{% warning %}
32+
33+
**Warning:** Do not remove any users or groups from the application for {% data variables.product.prodname_emus %} in your original IdP or tenant until after your migration is complete.
34+
35+
{% endwarning %}
36+
37+
1. If you don't already have single sign-on recovery codes for your enterprise, download the codes now. For more information, see "[Downloading your enterprise account's single sign-on recovery codes](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)."
38+
1. In your current IdP, deactivate provisioning in the application for {% data variables.product.prodname_emus %}.
39+
- If you use Azure AD, navigate to the "Provisioning" tab of the application, and then click **Stop provisioning**.
40+
- If you use Okta, navigate to the "Provisioning" tab of the application, click the **Integration** tab, and then click **Edit**. Deselect **Enable API integration**.
41+
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 "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#getting-started-with-enterprise-managed-users)."
42+
43+
1. Deactivate SAML for the {% data variables.enterprise.prodname_emu_enterprise %}.
44+
- From your profile, click **Your enterprises**, and then click the appropriate enterprise.
45+
- Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**, and then click **Authentication security**.
46+
- Under "SAML single sign-on", deselect **Require SAML authentication**, and then click **Save**.
47+
48+
1. Wait for all users in the enterprise to show as suspended.
49+
50+
1. While still signed in as the setup user, configure SAML and SCIM for the new IdP or tenant with a new {% data variables.product.prodname_emus %} application.
51+
52+
After you configure provisioning for the new application, the {% data variables.enterprise.prodname_managed_users %} will be unsuspended, and your developers will be able to sign into their existing accounts again.
53+
54+
By default, this process can take up to 40 minutes for Azure AD. To expedite the process for an individual user, click the **Provision on Demand** button in the "Provisioning" tab of the application for {% data variables.product.prodname_emus %}.
55+
56+
## Migrating when the normalized SCIM `userName` values will change
57+
58+
If the normalized SCIM `userName` values will change, {% data variables.product.company_short %} must provision a new enterprise account for your migration. [Contact our sales team](https://github.com/enterprise/contact) for help.

content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To configure authentication and user provisioning for {% data variables.product.
4444

4545
{% ifversion ghae %}
4646

47-
1. In Azure AD, add {% data variables.product.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.prodname_ghe_managed %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs.
47+
1. In Azure AD, add the {% data variables.enterprise.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.prodname_ghe_managed %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs.
4848

4949
1. In {% data variables.product.prodname_ghe_managed %}, enter the details for your Azure AD tenant.
5050

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Reference: #7781
2+
# Documentation for migrating an EMU-enabled enterprise's IdP or tenant
3+
versions:
4+
ghec: '*'

data/variables/enterprise.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@ prodname_emu_org: 'organization with managed users'
1313
## Phrase content so that the uncapitalized unified contributions or unified search variables are not used at the start of a sentence.
1414
prodname_unified_contributions: 'unified contributions'
1515
prodname_unified_search: 'unified search'
16+
17+
# Azure AD
18+
ae_azure_ad_app_link: '[GitHub AE application](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/aad.githubenterpriseserver)'

data/variables/product.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,6 @@ prodname_oauth_apps: 'OAuth Apps'
110110
prodname_enterprise_api: '{% ifversion ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% endif %} APIs'
111111
prodname_unfurls: 'Content Attachments'
112112

113-
# Azure AD
114-
ae_azure_ad_app_link: 'the [GitHub AE application](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/aad.githubenterpriseserver)'
115-
116113
# GitHub Actions
117114
## Use this variable only when referring to GitHub Actions the product. When referring to the thing that someone creates using the product, call it an action (small a). See the terminology page of the Brand Guide for more.
118115
prodname_actions: 'GitHub Actions'

0 commit comments

Comments
 (0)