Skip to content

Commit 968244e

Browse files
authored
Merge pull request github#15574 from github/repo-sync
repo sync
2 parents 5bcf6c1 + 5904bb1 commit 968244e

14 files changed

+105
-29
lines changed

content/admin/identity-and-access-management/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@ versions:
99
ghes: '*'
1010
ghae: '*'
1111
topics:
12+
- Accounts
13+
- Authentication
1214
- Enterprise
15+
- SSO
1316
children:
1417
- /authenticating-users-for-your-github-enterprise-server-instance
1518
- /managing-iam-for-your-enterprise
1619
- /managing-iam-with-enterprise-managed-users
20+
- /managing-recovery-codes-for-your-enterprise
1721
- /configuring-authentication-and-provisioning-with-your-identity-provider
1822
---
1923

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ redirect_from:
2626

2727
{% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.about-saml-enterprise-accounts %} For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise)."
2828

29+
{% data reusables.enterprise-accounts.about-recovery-codes %} For more information, see "[Managing recovery codes for your enterprise](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise)."
30+
2931
After you enable SAML SSO, depending on the IdP you use, you may be able to enable additional identity and access management features. {% data reusables.scim.enterprise-account-scim %}
3032

3133
If you use Azure AD as your IDP, you can use team synchronization to manage team membership within each organization. {% data reusables.identity-and-permissions.about-team-sync %} For more information, see "[Managing team synchronization for organizations in your enterprise account](/admin/authentication/managing-identity-and-access-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)."

content/admin/identity-and-access-management/managing-iam-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ For more detailed information about how to enable SAML using Okta, see "[Configu
8686
![Drop-downs for the Signature Method and Digest method hashing algorithms used by your SAML issuer](/assets/images/help/saml/saml_hashing_method.png)
8787
10. Before enabling SAML SSO for your enterprise, click **Test SAML configuration** to ensure that the information you've entered is correct. ![Button to test SAML configuration before enforcing](/assets/images/help/saml/saml_test.png)
8888
11. Click **Save**.
89+
{% data reusables.enterprise-accounts.download-recovery-codes %}
8990

9091
{% elsif ghae %}
9192

content/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ The setup user's username is your enterprise's shortcode suffixed with `_admin`.
7676

7777
{% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. To authenticate, a {% data variables.product.prodname_managed_user %} can visit their IdP application portal or use the login page on {% data variables.product.prodname_dotcom_the_website %}.
7878

79+
{% data reusables.enterprise-accounts.about-recovery-codes %} For more information, see "[Managing recovery codes for your enterprise](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise)."
80+
7981
### Authenticating as a {% data variables.product.prodname_managed_user %} via {% data variables.product.prodname_dotcom_the_website %}
8082

8183
1. Navigate to [https://github.com/login](https://github.com/login).

content/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ With {% data variables.product.prodname_emus %}, your enterprise uses SAML SSO t
2323

2424
{% data reusables.enterprise-accounts.emu-supported-idps %}
2525

26-
After you configure SAML SSO, we recommend storing your recovery codes so you can recover access to your enterprise in the event that your identity provider is unavailable. For more information, see "[Saving your recovery codes](#saving-your-recovery-codes)."
26+
After you configure SAML SSO, we recommend storing your recovery codes so you can recover access to your enterprise in the event that your identity provider is unavailable.
2727

2828
{% data reusables.saml.cannot-update-existing-saml-settings %}
2929

@@ -102,23 +102,10 @@ After you install and configure the {% data variables.product.prodname_emu_idp_a
102102

103103
{% endnote %}
104104

105-
1. To ensure you can still access your enterprise in the event that your identity provider is ever unavailable in the future, click **Download**, **Print**, or **Copy** to save your recovery codes.
106-
![Button to test SAML configuration before enforcing](/assets/images/help/saml/saml_recovery_code_options.png)
105+
{% data reusables.enterprise-accounts.download-recovery-codes %}
106+
107107

108108
### Enabling provisioning
109109

110110
After you enable SAML SSO, enable provisioning. For more information, see "[Configuring SCIM provisioning for enterprise managed users](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-scim-provisioning-for-enterprise-managed-users)."
111111

112-
## Saving your recovery codes
113-
114-
In the event that your identity provider is unavailable, you can use the setup user and a recovery code to sign in and access your enterprise. If you did not save your recovery codes when you configured SAML SSO, you can still access them from your enterprise's settings.
115-
116-
{% data reusables.enterprise-accounts.access-enterprise %}
117-
{% data reusables.enterprise-accounts.settings-tab %}
118-
{% data reusables.enterprise-accounts.security-tab %}
119-
120-
1. Under "Require SAML authentication", click **Save your recovery codes**.
121-
![Button to test SAML configuration before enforcing](/assets/images/help/enterprises/saml-recovery-codes-link.png)
122-
123-
2. To save your recovery codes, click **Download**, **Print**, or **Copy**.
124-
![Button to test SAML configuration before enforcing](/assets/images/help/saml/saml_recovery_code_options.png)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Accessing your enterprise account if your identity provider is unavailable
3+
shortTitle: Access your enterprise account
4+
intro: "You can sign into {% data variables.product.product_name %} even if your identity provider is unavailable by bypassing SAML single sign-on (SSO) with a recovery code."
5+
versions:
6+
ghec: '*'
7+
type: how_to
8+
topics:
9+
- Accounts
10+
- Authentication
11+
- Enterprise
12+
- SSO
13+
permissions: "Enterprise owners can use a recovery code to access an enterprise account."
14+
---
15+
16+
You can use a recovery code to access your enterprise account when a SAML configuration error or an issue with your identity provider (IdP) prevents you from using SAML SSO.
17+
18+
In order to access your enterprise account this way, you must have previously downloaded and stored the recovery codes for your enterprise. For more information, see "[Downloading your enterprise account's SAML single sign-on recovery codes](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-saml-single-sign-on-recovery-codes)."
19+
20+
{% data reusables.saml.recovery-code-caveats %}
21+
22+
{% note %}
23+
24+
**Note:** If your enterprises uses {% data variables.product.prodname_emus %}, you must sign in as the setup user to use a recovery code.
25+
26+
{% endnote %}
27+
28+
{% data reusables.saml.recovery-code-access %}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Downloading your enterprise account's SAML single sign-on recovery codes
3+
shortTitle: Download recovery codes
4+
intro: "To ensure that you can access {% data variables.product.product_name %} if your identity provider (IdP) is unavailable, you should download your enterprise account's SAML single sign-on (SSO) recovery codes."
5+
versions:
6+
ghec: '*'
7+
type: how_to
8+
topics:
9+
- Accounts
10+
- Authentication
11+
- Enterprise
12+
- SSO
13+
permissions: "Enterprise owners can download the SAML SSO recovery codes for the enterprise account."
14+
---
15+
16+
In the event that your IdP is unavailable, you can use a recovery code to sign in and access your enterprise on {% data variables.product.product_location %}. For more information, see "[Accessing your enterprise account if your identity provider is unavailable](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable)."
17+
18+
If you did not save your recovery codes when you configured SAML SSO, you can still access the codes from your enterprise's settings.
19+
20+
{% data reusables.enterprise-accounts.access-enterprise %}
21+
{% data reusables.enterprise-accounts.settings-tab %}
22+
{% data reusables.enterprise-accounts.security-tab %}
23+
24+
1. Under "Require SAML authentication", click **Save your recovery codes**.
25+
![Screenshot of the button to test SAML configuration before enforcing](/assets/images/help/enterprises/saml-recovery-codes-link.png)
26+
27+
2. To save your recovery codes, click **Download**, **Print**, or **Copy**.
28+
![Screenshot of the buttons to download, print, or copy your recovery codes](/assets/images/help/saml/saml_recovery_code_options.png)
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Managing recovery codes for your enterprise
3+
shortTitle: Manage recovery codes
4+
intro: "With SAML single sign-on recovery codes, you can access your enterprise account even when your identity provider is unavailable."
5+
versions:
6+
ghec: '*'
7+
topics:
8+
- Accounts
9+
- Authentication
10+
- Enterprise
11+
- SSO
12+
children:
13+
- /downloading-your-enterprise-accounts-saml-single-sign-on-recovery-codes
14+
- /accessing-your-enterprise-account-if-your-identity-provider-is-unavailable
15+
---
16+

content/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,9 @@ shortTitle: Unavailable identity provider
1414

1515
Organization administrators can use [one of their downloaded or saved recovery codes](/articles/downloading-your-organization-s-saml-single-sign-on-recovery-codes) to bypass single sign-on. You may have saved these to a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/).
1616

17-
{% note %}
17+
{% data reusables.saml.recovery-code-caveats %}
1818

19-
**Note:** You can only use recovery codes once and you must use them in consecutive order. Recovery codes grant access for 24 hours.
20-
21-
{% endnote %}
22-
23-
1. At the bottom of the single sign-on dialog, click **Use a recovery code** to bypass single sign-on.
24-
![Link to enter your recovery code](/assets/images/help/saml/saml_use_recovery_code.png)
25-
2. In the "Recovery Code" field, type your recovery code.
26-
![Field to enter your recovery code](/assets/images/help/saml/saml_recovery_code_entry.png)
27-
3. Click **Verify**.
28-
![Button to verify your recovery code](/assets/images/help/saml/saml_verify_recovery_codes.png)
29-
30-
After you've used a recovery code, make sure to note that it's no longer valid. You will not be able to reuse the recovery code.
19+
{% data reusables.saml.recovery-code-access %}
3120

3221
## Further reading
3322

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
If a SAML configuration error or an issue with your identity provider (IdP) prevents you from using SAML SSO, you can use a recovery code to access your enterprise.

0 commit comments

Comments
 (0)