This version of GitHub Enterprise Server was discontinued on 2024-09-25. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

Changing your GitHub username

You can change the username for your account on GitHub if your instance uses built-in authentication.

In this article

Note

If you sign into your GitHub Enterprise Server instance with LDAP credentials or single sign-on (SSO), only your local administrator can change your username. For more information about authentication methods for GitHub Enterprise Server, see "Understanding IAM for enterprises."

About username changes

You can change your username to another username that is not currently in use.

After changing your username, your old username becomes available for anyone else to claim. Most references to your repositories under the old username automatically change to the new username. However, some links to your profile won't automatically redirect.

GitHub Enterprise Server cannot set up redirects for:

  • @mentions using your old username
  • Links to gists that include your old username

If the account namespace includes any packages or container images stored in a GitHub Packages registry, GitHub transfers the packages and container images to the new namespace. By renaming your account, you may break projects that depend on these packages.

Repository references

After you change your username, GitHub Enterprise Server will automatically redirect references to your repositories.

  • Web links to your existing repositories will continue to work. This can take a few minutes to complete after you make the change.
  • Command line pushes from your local repository clones to the old remote tracking URLs will continue to work.

If the new owner of your old username creates a repository with the same name as your repository, that will override the redirect entry and your redirect will stop working. Because of this possibility, we recommend you update all existing remote repository URLs after changing your username. For more information, see "Managing remote repositories."

Links to your previous profile page

After changing your username, links to your previous profile page, such as https://HOSTNAME/previoususername, will return a 404 error. We recommend updating any links to your profile from elsewhere.

Accounts logged in on GitHub Mobile

Accounts logged in on the GitHub Mobile app may continue to display your original username until you log out. To ensure your updated username is displayed, we recommend you sign out and back in to your account on each mobile device.

Your Git commits

If your Git commits are associated with another email address you've added to your GitHub account, they'll continue to be attributed to you and appear in your contributions graph after you've changed your username. For more information on setting your email address, see "Setting your commit email address" and "Adding an email address to your GitHub account."

Warning

  • After a username change, verified commits signed using the previous GitHub Enterprise Server-provided noreply email address will lose their "Verified" status.
  • When verifying a signature, GitHub Enterprise Server checks that the email address of the committer or tagger exactly matches one of the email addresses associated with the GPG key's identities. Additionally, GitHub Enterprise Server confirms that the email address is verified and linked to the user's account. This ensures that the key belongs to you and that you created the commit or tag. Because the username of the noreply email address changes, these commits can no longer be verified.

Your gists

After changing your username, the URLs to any public or secret gists will also change and previous links to these will return a 404 error. We recommend updating the links to these gists anywhere you may have shared them.

CODEOWNERS files

After changing your username, CODEOWNERS files that include your old username will need to be manually updated. When you view the CODEOWNERS files on GitHub, an error message is displayed if the file contains any unknown users, or users without write access. We recommend updating all relevant CODEOWNERS files with your new username. For more information, see "About code owners."

Changing your username

  1. In the upper-right corner of any page on GitHub, click your profile photo, then click Settings.
  2. In the left sidebar, click Account.
  3. In the "Change username" section, click Change username.

Further reading