Skip to content

Latest commit

 

History

History
136 lines (97 loc) · 5.1 KB

multiple-users.md

File metadata and controls

136 lines (97 loc) · 5.1 KB
Raw

Multiple users

If you work with multiple different identities on a single Git hosting service, you may be wondering if Git Credential Manager (GCM) supports this workflow. The answer is yes, with a bit of complexity due to how it interoperates with Git.

Prompted to select an account?

Read the TL;DR section below for a quick summary of how to make GCM remember which account to use for which repository.

Foundations: Git and Git hosts

Git itself doesn't have a single, strong concept of "user". There's the user.name and user.email which get embedded into commit headers/trailers, but these are arbitrary strings. GCM doesn't interact with this notion of a user at all. You can put whatever you want into your user.* config, and nothing in GCM will change at all.

Separate from the user strings in commits, Git recognizes the "user" part of a remote URL or a credential. These are not often used, at least by default, in the web UI of major Git hosts.

Git hosting providers (like GitHub or Bitbucket) do have a concept of "user". Typically it's an identity like a username or email address, plus a password or other credential to perform actions as that user. You may have guessed by now that GCM (the Git Credential Manager) does work with this notion of a user.

People, identities, credentials, oh my

You (a physical person) may have one or more user accounts (identities) with one or more Git hosting providers. Since most Git hosts don't put a "user" part in their URLs, by default, Git will treat the user part for a remote as the empty string. If you have multiple identities on one domain, you'll need to insert a unique user part per-identity yourself.

There are good reasons for having multiple identities on one domain. You might use one GitHub identity for your personal work, another for your open source work, and a third for your employer's work. You can ask Git to assign a different credential to different repositories hosted on the same provider. HTTPS URLs include an optional "name" part before an @ sign in the domain name, and you can use this to force Git to distinguish multiple users. This should likely be your username on the Git hosting service, since there are cases where GCM will use it like a username.

Setting it up

As an example, let's say you're working on multiple repositories hosted at the same domain name.

Repo URL Identity
https://example.com/open-source/library.git contrib123
https://example.com/more-open-source/app.git contrib123
https://example.com/big-company/secret-repo.git employee9999

When you clone these repos, include the identity and an @ before the domain name in order to force Git and GCM to use different identities. If you've already cloned the repos, you can update the remote URL to include the identity.

Example: fresh clones

# instead of `git clone https://example.com/open-source/library.git`, run:
git clone https://contrib123@example.com/open-source/library.git

# instead of `git clone https://example.com/big-company/secret-repo.git`, run:
git clone https://employee9999@example.com/big-company/secret-repo.git

Example: existing clones

# in the `library` repo, run:
git remote set-url origin https://contrib123@example.com/open-source/library.git

# in the `secret-repo` repo, run:
git remote set-url origin https://employee9999@example.com/big-company/secret-repo.git

Azure DevOps

Azure DevOps has some additional, optional complexity which you should also be aware of if you're using it.

GitHub

You can use the github [list | login | logout] commands to manage your GitHub accounts. These commands are documented in the command-line usage or by running git credential-manager github --help.

TL;DR: Tell GCM to remember which account to use

To set a default account for a particular remote you can simply set the following Git configuration:

git config --global credential.<URL>.username <USERNAME>

..where <URL> is the remote URL and <USERNAME> is the account you wish to have as the default. For example, for github.com and the user alice:

git config --global credential.https://github.com.username alice

If you wish to set a user for a specific repository or remote URL, you can include the account name in the remote URL. If you're using HTTPS remotes, you can include the account name in the URL by inserting it before the @ sign in the domain name.

For example, if you want to always use the alice account for the mona/test GitHub repository, you can clone it using the alice account by running:

git clone https://alice@github.com/mona/test

To update an existing clone, you can run git remote set-url to update the URL:

git remote set-url origin https://alice@github.com/mona/test

If your account name includes an @ then remember to escape this character using %40: https://alice%40contoso.com@example.com/test.