Update setup user authentication instructions#44708
Conversation
Clarified the requirements for signing in with setup user and the process for entering enterprise recovery codes.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds guidance about using enterprise recovery codes for the setup user after SSO authentication is configured.
Changes:
- Adds a NOTE describing the setup user’s need for enterprise recovery codes after authentication is configured.
- Documents a brief flow for entering recovery codes during SSO sign-in.
Show a summary per file
| File | Description |
|---|---|
| content/admin/concepts/identity-and-access-management/setup-user.md | Adds a note about recovery codes required for setup user login after authentication/SSO is configured. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 2
| > Once authentication has been configured on the enterprise, the setup user requires the [enterprise recovery codes](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes) to be able to login. | ||
| > To enter the recovery codes, sign in as admin on the SSO prompt, enter username and password which will bring up the dialogue for recovery codes. |
| > Once authentication has been configured on the enterprise, the setup user requires the [enterprise recovery codes](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes) to be able to login. | ||
| > To enter the recovery codes, sign in as admin on the SSO prompt, enter username and password which will bring up the dialogue for recovery codes. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
| {% data reusables.enterprise-accounts.emu-password-reset-session %} | ||
|
|
||
| > [!NOTE] | ||
| > Once authentication has been configured on the enterprise, the setup user requires the [enterprise recovery codes](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes) to be able to login. |
There was a problem hiding this comment.
Thanks for working on this @wi11ialvl ! A couple of thoughts:
-
The first line says recovery codes are always required when the setup user is logging in, once auth is configured for the enterprise, but that contradicts the bullet points in the article -- enterprise recovery codes are only required at every setup user login when 2FA isn't enabled.
-
What if we add the following instead of the note (combined with the existing bullet points, could make it more clear)?
- Navigate to github.com/login.
- Enter the setup user's username (for example,
shortcode_admin) and password.- Complete your 2FA challenge, or enter an enterprise recovery code if prompted. Enterprise recovery codes are not the same as personal two-factor authentication recovery codes. For more information, see AUTOTITLE.
The steps could go right after "the setup user cannot sign in via SSO" and before the bullet points about recovery codes. That way the flow reads: you can't use SSO --> here's how you do sign in --> here's what to expect about recovery codes.
There was a problem hiding this comment.
Yes, this is better. Let's do this.
Clarified the requirements for signing in with setup user and the process for entering enterprise recovery codes.
Why: There is a lack of clarity on how to enter recovery codes when attempting to login with the setup user
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following: