Versions Compared

Old Version 7

changes.mady.by.user Andrea Reynolds

Saved on

compared with

New Version 8

changes.mady.by.user Ryan E Elstad

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

GitHub Passkeys provide a secure method for signing into GitHub.com without the need for a password. For those utilizing two-factor authentication (2FA), a passkey fulfills both the password and 2FA criteria, streamlining the sign-in process to just one step. 

Info
titlePlease Note:

In order to set up passkey, your GitHub 2FA must be configured first.


On This Page

Table of Contents
minLevel3

Enabling the feature preview for Passkeys

Before you are able to use Passkey with GitHub you will need to enable the feature:

  1. In the upper-right corner of any page, click your profile photo, then click Feature preview
  2. To the right of "Passkeys", click Enable

Setup Passkey for YubiKey

GitHub Passkeys offer a seamless and secure sign-in experience on GitHub.com, eliminating the need for password input. When combined with two-factor authentication (2FA), a passkey acts as both the password and 2FA, granting access in a single step.

WarningYou will not be able to set up a passkey until you have 2FA set up on your GitHub account.

 

How to Add a Passkey to Your GitHub Account:

  1. Access Settings:

    • Click your profile photo on the upper-right corner of any GitHub page and select Settings.

  2. Navigate to Authentication:

    • In the sidebar's Access section, choose Password and authentication.

  3. Initiate Passkey Setup:

    • Under "Passkeys", select Add a passkey. Authenticate if prompted using your password or another existing method.

    Configure Authentication:


Image Added

    • Under “Configure passwordless authentication”, click Add passkey and follow your passkey provider's instructions.

  2. Confirmation:

    • After successfully registering your passkey, you'll see a confirmation page. Click Done.

Setup 2FA for GitHub Using Microsoft Authenticator App

Two-factor authentication (2FA) on GitHub is a secure method that requires both a password and an authentication code generated by an app on your mobile device to sign in. To bolster security, we recommend setting up 2FA using a time-based one-time password (TOTP) application, like Microsoft Authenticator App, instead of SMS. Microsoft Authenticator generates authentication codes that change over time and provide a more reliable experience.

Steps to Enable 2FA on GitHub:

Download a TOTP app:

If you haven’t already, install the Microsoft Authenticator App on your mobile device.

Navigate to Settings:

On GitHub, click your profile photo at the upper-right corner, and then select Settings.

Access Two-Factor Settings:

In the sidebar's Access section, choose Password and authentication. Click Enable two-factor authentication in the "Two-factor authentication" section.

Setup Authenticator App:

Under "Setup authenticator app":

  • Scan the displayed QR code using your Authenticator App. The app will then display a six-digit code.
    • If scanning isn't possible, click enter this text code to get a code that you can manually input into your Authenticator App.

    Verify the Code:

    Your Authenticator App will now save your GitHub.com account and produce a new authentication code every few seconds. Enter this code on GitHub in the "Verify the code from the app" field.

    Backup with Recovery Codes:

    Click Download under "Save your recovery codes" to save these codes to your device. It's crucial to keep these codes safe, as they can help regain access to your account if you lose your primary authentication method.

    Finalize Setup:

    After storing your recovery codes safely, click I have saved my recovery codes to officially activate 2FA for your account.
    InfoFor 28 days after 2FA setup, you're in a check-up period. Ensure to successfully perform 2FA within these 28 days, or you'll be prompted to do so on the 28th day. If you fail, use the provided shortcut to adjust your 2FA settings and maintain GitHub.com access

      • .



    Signing In Using a Passkey

    1. Visit the Login Page:
    2. Choose Passkey Sign-In:
      • Click Sign in with a passkey.

    3. Authenticate:
      • Follow the prompts from to enter your YubiKey PIN and press the medallion to use biometric access.

    Troubleshooting

    If you do not see the "Sign in with a passkey" option after successfully setting up your YubiKey, try using this sign-in link: https://github.com/login?passkey=true