Skip to content

Commit ce8415e

Browse files
joshuawalkerjc-clarkjessicacano
authored
Add "Troubleshooting two-factor authentication issues" article (#57481)
Co-authored-by: Joe Clark <[email protected]> Co-authored-by: Jessica <[email protected]>
1 parent 46f0121 commit ce8415e

File tree

9 files changed

+128
-20
lines changed

9 files changed

+128
-20
lines changed

content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ If you access {% data variables.product.github %} using other methods, such as t
2525

2626
{% else %}
2727

28-
With two-factor authentication enabled, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in GitHub Mobile,{% endif %} or use a security key when accessing {% data variables.product.github %} through your browser. If you access {% data variables.product.github %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
28+
With two-factor authentication enabled, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in GitHub Mobile,{% endif %} or use a passkey or security key when accessing {% data variables.product.github %} through your browser. If you access {% data variables.product.github %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
2929

3030
{% endif %}
3131

@@ -101,20 +101,12 @@ Enabling 2FA doesn't change how you authenticate to {% data variables.product.gi
101101

102102
## Troubleshooting
103103

104-
If you lose access to your two-factor authentication credentials, you can use your recovery codes or another recovery method (if you've set one up) to regain access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
105-
106-
{% ifversion fpt or ghec %}
107-
108-
> [!NOTE]
109-
> {% data reusables.two_fa.unlink-email-address %}
110-
111-
{% endif %}
112-
113-
If your authentication fails several times, you may wish to synchronize your phone's clock with your mobile provider. Often, this involves checking the "Set automatically" option on your phone's clock, rather than providing your own time zone.
104+
If you are receiving a "Two-factor authentication failed" error when authenticating with 2FA, the authentication code you are entering is incorrect. You can try troubleshooting your configured authentication methods before attempting account recovery. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues).
114105

115106
## Further reading
116107

117108
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)
118109
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)
119110
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods)
111+
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues)
120112
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials)

content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Changing your two-factor authentication method
3-
intro: You can change two-factor authentication (2FA) method without disabling 2FA entirely.
3+
intro: You can change your two-factor authentication (2FA) method without disabling 2FA entirely.
44
redirect_from:
55
- /articles/changing-two-factor-authentication-delivery-methods
66
- /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device

content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}
5252
{% endif %}
5353

5454
> [!NOTE]
55-
> You can reconfigure your 2FA settings without disabling 2FA entirely, allowing you to keep both your recovery codes and your membership in organizations that require 2FA.
55+
> You can reconfigure your 2FA settings without disabling 2FA entirely, allowing you to keep both your recovery codes and your membership in organizations that require 2FA. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method).
5656
5757
## Configuring two-factor authentication using a TOTP app
5858

@@ -141,5 +141,6 @@ After signing in and turning on push notifications, you can now use your device
141141
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)
142142
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods)
143143
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication)
144+
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues)
144145
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials)
145146
* [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)

content/authentication/securing-your-account-with-two-factor-authentication-2fa/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@ topics:
1414
- 2FA
1515
children:
1616
- /about-two-factor-authentication
17+
- /about-mandatory-two-factor-authentication
1718
- /configuring-two-factor-authentication
1819
- /configuring-two-factor-authentication-recovery-methods
1920
- /accessing-github-using-two-factor-authentication
20-
- /recovering-your-account-if-you-lose-your-2fa-credentials
21-
- /changing-your-two-factor-authentication-method
22-
- /about-mandatory-two-factor-authentication
2321
- /countries-where-sms-authentication-is-supported
22+
- /changing-your-two-factor-authentication-method
23+
- /troubleshooting-two-factor-authentication-issues
24+
- /recovering-your-account-if-you-lose-your-2fa-credentials
2425
- /disabling-two-factor-authentication-for-your-personal-account
2526
shortTitle: Secure your account with 2FA
2627
---

content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Use one of your recovery codes to automatically regain entry into your account.
3535
{% data reusables.accounts.prompt-for-2fa-recovery-code %}
3636
1. Type one of your recovery codes, then click **Verify**.
3737

38+
> [!NOTE]
39+
> If you are receiving a "Recovery code authentication failed" error when using a recovery code, the code you are entering is invalid. You can try troubleshooting your recovery codes. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues).
40+
3841
## Authenticating with a passkey
3942

4043
If you have added a passkey to your account, you can use your passkey to automatically regain access to your account. Passkeys satisfy both password and 2FA requirements, so you don't need to know your password in order to recover your account. See [AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys).
@@ -101,4 +104,5 @@ If you have exhausted your recovery options, you can unlink your email address f
101104

102105
## Further reading
103106

107+
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues)
104108
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods)
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Troubleshooting two-factor authentication issues
3+
intro: 'If you are having trouble authenticating with 2FA, you can try troubleshooting your configured authentication methods.'
4+
versions:
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '*'
8+
topics:
9+
- 2FA
10+
- Authentication
11+
shortTitle: Troubleshooting 2FA
12+
---
13+
14+
If you are receiving a "Two-factor authentication failed" error when authenticating with two-factor authentication (2FA), the authentication code you are entering is incorrect. You can try troubleshooting your configured authentication methods before attempting account recovery.
15+
16+
## Troubleshooting authentication using a TOTP app
17+
18+
### Use the right app
19+
20+
When authenticating with a TOTP app, {% data variables.product.github %} does not send you anything; you need to provide {% data variables.product.github %} with a valid code, based on the secret key that you saved to your TOTP app when 2FA was set up. Find the app or program that you originally used to setup 2FA and retrieve the authentication code from there.
21+
22+
### Check your device’s date and time
23+
24+
TOTP codes are time‑based. If the clock on your phone or computer is out of sync with {% data variables.product.github %}'s server, the code will be invalid. Ensure that your device’s date, time and time zone are set automatically by your network provider. On most mobile devices, this means turning on the **Set automatically** option.
25+
26+
### Wait for a new code and enter it promptly
27+
28+
Codes change every 30 seconds. Open your TOTP app, wait for the next code to appear and enter it immediately. Avoid typing spaces or extra characters as these will make the code invalid.
29+
30+
### Verify you’re using the correct account entry
31+
32+
Most TOTP apps support multiple accounts for a single website. Make sure you’re reading the code from the correct entry in the app. Codes generated for a different account will not work.
33+
34+
### Restore from a TOTP backup
35+
36+
Many TOTP apps support cloud backup or key export. If you lose or reset your device, you may be able restore your 2FA data from the app’s backup to a new device. Consult your app’s documentation for instructions.
37+
38+
{% ifversion fpt or ghec %}
39+
40+
## Troubleshooting authentication using text messages
41+
42+
### Confirm that you can receive text messages
43+
44+
Make sure your device and cellular plan is capable of receiving Short Message Service (SMS) messages. Some "data-only" phone plans and tablet devices connected to a cellular network may not support receiving text messages. Check with your provider and device manufacturer.
45+
46+
Carrier rates may apply for received SMS messages. Ensure your cellular plan covers potential charges.
47+
48+
Disable "Do Not Disturb" mode or spam‑filtering apps that might block receipt of authentication codes.
49+
50+
### Check that you have cellular coverage
51+
52+
Receiving text messages generally requires a strong network signal. Ensure you have adequate coverage before requesting an authentication code.
53+
54+
### Power cycle your phone
55+
56+
Turning your phone off and on will re-register the device with the network, which may resolve some deliverability issues. Enabling and disabling an "Airplane Mode" may also be sufficient, but power cycling your phone is more reliable.
57+
58+
### Consult with your cellular provider
59+
60+
Check with your cellular provider or carrier to see if there are any local outages or delivery issues in your area. They may also be able to investigate delivery issues for your connection. Provide them with the SMS number configured on your {% data variables.product.github %} account and the time that you requested an authentication code from {% data variables.product.github %}.
61+
62+
> [!NOTE]
63+
> {% data variables.product.github %}, along with our SMS delivery partners, proactively monitors our SMS deliverability success rates. Periods of low-deliverability that would indicate a widespread issue are promptly investigated. You can check active and historical incidents affecting SMS delivery in your region on [{% data variables.product.github %}'s status page](https://githubstatus.com).
64+
65+
{% endif %}
66+
67+
## Recovering your account if troubleshooting doesn't help
68+
69+
If you have tried troubleshooting and you are still having trouble, you can try authenticating with another method, such as a passkey, {% ifversion fpt or ghec %}{% data variables.product.prodname_mobile %},{% endif %} or a security key, if pre-configured on the account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication).
70+
71+
{% ifversion fpt or ghec %}
72+
73+
> [!WARNING]
74+
> For security reasons, {% data variables.contact.github_support %} cannot assist with troubleshooting your 2FA methods, including SMS delivery.
75+
76+
{% endif %}
77+
78+
If you don't have another authentication method, you will need to try account recovery. For more information about account recovery, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
79+
80+
## Troubleshooting using recovery codes
81+
82+
If you are receiving a "Recovery code authentication failed" error when using a recovery code, the code you are entering is invalid. You can try troubleshooting your recovery codes.
83+
84+
### Use one code at a time
85+
86+
A set of recovery codes contains more than one code. A single code is 10 alphanumeric characters with a hyphen in the middle: `xxxxx-yyyyy`.
87+
88+
### Try using a different code
89+
90+
Each code is single-use only: once it has been used to authenticate, it cannot be used again. Try using a different code from the set.
91+
92+
### Check you're using the right set of codes
93+
94+
When 2FA is disabled and re-enabled, a new set of codes are created which invalidates the previous set. Recovery codes are also invalidated whenever a new set of codes is generated. Even if you think you might not have another set of codes, you could try searching for them in your devices, backups, and password managers. They will have the default filename `github-recovery-codes.txt`.
95+
96+
## Further reading
97+
98+
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)
99+
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication)
100+
* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials)
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
1. Navigate to [https://github.com/login](https://github.com/login).
1+
1. Navigate to {% data variables.product.login_url %}.
22
1. To prompt two-factor authentication, type your username and password, then click **Sign in**.
3+
{% ifversion fpt or ghec %}
4+
35
> [!NOTE]
4-
> If you have linked a Google account to your {% data variables.product.prodname_dotcom %} account, you can sign-in with your social login instead of using your password.
6+
> If you have linked a social account to your {% data variables.product.github %} account, you can sign-in with your social login instead of using your password.
7+
8+
{% endif %}
59
1. Under "More options", click **2FA recovery code**.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
For security reasons, {% data variables.product.company_short %} Support [will not be able to restore access to accounts](/free-pro-team@latest/site-policy/other-site-policies/github-account-recovery-policy) with two-factor authentication enabled if you lose your two-factor authentication credentials or lose access to your account recovery methods.
1+
For security reasons, {% data variables.contact.github_support %} [will not be able to restore access to accounts](/free-pro-team@latest/site-policy/other-site-policies/github-account-recovery-policy) with two-factor authentication enabled if you lose your two-factor authentication credentials or lose access to your account recovery methods.

data/variables/product.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ prodname_learning_link: 'https://skills.github.com/'
237237
prodname_roadmap: 'GitHub public roadmap'
238238
prodname_roadmap_link: 'https://github.com/github/roadmap#github-public-roadmap'
239239

240-
# GitHub support
240+
# GitHub Support plans
241241
standard_support_plan: 'Standard plan'
242242
premium_support_plan: 'Premium plan'
243243
premium_plus_support_plan: 'Premium Plus plan / GitHub Engineering Direct'
@@ -334,6 +334,12 @@ pricing_url: 'https://github.com/pricing'
334334
pricing_link: '[GitHub Pricing](https://github.com/pricing)'
335335
raw_github_com: >-
336336
{% ifversion fpt or ghec %}raw.githubusercontent.com{% else %}HOSTNAME/user/repo/raw{% endif %}
337+
login_url: >-
338+
{%- ifversion fpt or ghec %}
339+
[`https://github.com/login`](https://github.com/login)
340+
{%- elsif ghes %}
341+
`http(s)://HOSTNAME/login`
342+
{%- endif %}
337343
# GitHub Enterprise Server past versions
338344
current-340-version: '11.10.354'
339345

0 commit comments

Comments
 (0)