Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Templetize cURL examples that use usernames and tokens for authentication #346

Merged
izuzak merged 1 commit into from
Nov 1, 2013
Merged

Templetize cURL examples that use usernames and tokens for authentication #346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions content/v3/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,23 @@ To use Basic Authentication with the GitHub API, simply send the username and
password associated with the account.

For example, if you're accessing the API via [cURL][curl], the following command
would authenticate with `mojombo` as the username. (cURL will prompt you to
enter the password.)
would authenticate you if you replace `<username>` with your GitHub username.
(cURL will prompt you to enter the password.)

<pre class='terminal'>
curl -u mojombo https://api.github.com/user
curl -u <username> https://api.github.com/user
</pre>

### Via OAuth Tokens

Alternatively, you can authenticate using [personal access
tokens][personal-access-tokens] or OAuth tokens. To do so, provide the token as
the username and provide a blank password or a password of `x-oauth-basic`. For
example:
the username and provide a blank password or a password of `x-oauth-basic`. If
you're accessing the API via cURL, replace `<token>` with your OAuth token in
the following command:

<pre class='terminal'>
curl -u 3816d821c80a6847ca84550052c1ff6246e8169b:x-oauth-basic https://api.github.com/user
curl -u <token>:x-oauth-basic https://api.github.com/user
</pre>

This approach is useful if your tools only support Basic Authentication but you
Expand Down