You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 21, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: docs/getting-started/authenticating-to-github.md
+31-21Lines changed: 31 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,43 @@
1
1
# Authenticating to GitHub
2
2
3
-
Add your GitHub.com or GitHub Enterprise account information to GitHub Desktop so you can access your repositories.
3
+
## How to login to GitHub or GitHub Enterprise
4
+
5
+
1. In Visual Studio, select **Team Explorer** from the **View** menu.
6
+
<ahref="images/view_team_explorer.png?raw=true"target="_blank"><div><imgsrc="images/view_team_explorer.png"alt="Team Explorer in the view menu"width="500px"/></div></a>
7
+
1. In the Team Explorer pane, click the **Manage Connectios** toolbar icon.
8
+
<ahref="images/manage_connections.png?raw=true"target="_blank"><div><imgsrc="images/manage_connections.png"alt="Manage connections toolbar icon in the Team Explorer pane"width="500px"/></div></a>
9
+
1. Click the **Connect** link in the GitHub section.
10
+
<ahref="images/sign-in-to-github-provider.png?raw=true"target="_blank"><div><imgsrc="images/sign-in-to-github-provider.png"alt="Connect to GitHub"height="300px"/></div></a>
11
+
12
+
If you're connected to a TFS instance, click on the **Sign in** link instead
13
+
<ahref="images/sign-in-to-github.png?raw=true"target="_blank"><div><imgsrc="images/sign-in-to-github.png"alt="Sign in to GitHub"width="300px"/></div></a>
14
+
15
+
If none of these options are visible, click **Manage Connections** and then **Connect to GitHub**.
16
+
<ahref="images/connect_to_github.png?raw=true"target="_blank"><div><imgsrc="images/connect_to_github.png"alt="Connect to GitHub in the manage connections dropdown in the Team Explorer pane"width="500px"/></div></a>
17
+
1. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
18
+
19
+
**GitHub option**:
20
+
<ahref="images/connect-to-github-dialog.png?raw=true"target="_blank"><div><imgsrc="images/connect-to-github-dialog.png"alt="Connect to GitHub dialog view"height="400px"/></div></a>
21
+
22
+
- To sign in with credentials, enter either username or email and password.
23
+
- To sign in with SSO, select `Sign in with your browser`.
24
+
25
+
**GitHub Enterprise option**:
26
+
<ahref="images/connect-to-github-enterprise-dialog.png?raw=true"target="_blank"><div><imgsrc="images/connect-to-github-enterprise-dialog.png"alt="Connect to GitHub Enterprise dialog view"height="400px"/></div></a>
27
+
28
+
- To sign in with SSO, enter the GitHub Enterprise server address and select `Sign in with your browser`.
29
+
- To sign in with credentials, enter the GitHub Enterprise server address.
30
+
- If a `Password` field appears, enter your password.
31
+
- If a `Token` field appears, enter a valid token. You can create personal access tokens by [following the instructions in the section below](#personal_access_tokens).
4
32
5
33
Before you authenticate, you must already have a GitHub or GitHub Enterprise account.
6
34
7
35
- For more information on creating a GitHub account, see "[Signing up for a new GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/)".
8
36
- For a GitHub Enterprise account, contact your GitHub Enterprise site administrator.
9
37
10
-
**Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has not enabled SAML single sign-on or login with username and password, you must create and authorize a personal access token to access protected content. In addition, SAML single sign-on is not available for GitHub enterprise versions less than 2.12.2.
38
+
### Personal access tokens
11
39
12
-
### Scopes for personal access tokens
40
+
If all signin options above fail, you can manually create a personal access token and use it as your password.
13
41
14
42
The scopes for the personal access token are: `user`, `repo`, `gist`, and `write:public_key`.
15
43
-*user* scope: Grants access to the user profile data. We currently use this to display your avatar and check whether your plans lets you publish private repositories.
@@ -20,21 +48,3 @@ The scopes for the personal access token are: `user`, `repo`, `gist`, and `write
20
48
For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).
21
49
22
50
For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)."
23
-
24
-
1. In Visual Studio, select **Team Explorer** from the **View** menu.
25
-

26
-
2. In the Team Explorer pane, click the **Manage Connections** toolbar button.
27
-

28
-
3. Click the **Connect** link in the GitHub section. If you are already connected to a GitHub instance and want to connect to another, this link will not be visible; instead click **Manage Connections** and then **Connect to GitHub**.
29
-

30
-
4. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
31
-
32
-
**GitHub option**:
33
-

34
-
- To sign in with credentials, enter either username or email and password.
35
-
- To sign in with SSO, select `Sign in with your browser`.
36
-
37
-
**GitHub Enterprise option**:
38
-

39
-
- To sign in with credentials, first enter GitHub Enterprise server address. Once a valid server address is entered, a `Token` field appears and a valid token can be entered to sign in.
40
-
- To sign in with SSO, first enter the GitHub Enterprise server address. Once a valid server address is entered, select `Sign in with your browser`. Follow the steps to authenticate with your SSO provider.
0 commit comments