Skip to content

Commit c8e2a6b

Browse files
jasonrudolphjasonrudolph
committed
Document and announce enhancements for 2FA
1 parent b928ee2 commit c8e2a6b

File tree

97 files changed

+938
-156
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+938
-156
lines changed

‎changes.atom‎

Lines changed: 70 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,62 @@
22
<feed xmlns="http://www.w3.org/2005/Atom">
33
<id>http://developer.github.com/</id>
44
<title>GitHub API Changes</title>
5-
<updated>2013-08-20T04:00:00Z</updated>
5+
<updated>2013-09-03T04:00:00Z</updated>
66
<link rel="alternate" href="http://developer.github.com/" />
77
<link rel="self" href="http://developer.github.com/changes.atom" />
88
<author>
99
<name>technoweenie</name>
1010
<uri>https://github.com/technoweenie</uri>
1111
</author>
12+
<entry>
13+
<id>tag:developer.github.com,2013-09-03:/changes/2013-09-03-two-factor-authentication/</id>
14+
<title type="html">Two-Factor Authentication and the API</title>
15+
<published>2013-09-03T04:00:00Z</published>
16+
<updated>2013-09-03T04:00:00Z</updated>
17+
<author>
18+
<name>mastahyeti</name>
19+
<uri>https://github.com/technoweenie</uri>
20+
</author>
21+
<link rel="alternate" href="http://developer.github.com/changes/2013-09-03-two-factor-authentication/" />
22+
<content type="html">&lt;p&gt;As &lt;a href="https://github.com/blog/1614-two-factor-authentication"&gt;announced earlier today&lt;/a&gt;, GitHub.com now supports two-factor
23+
authentication (2FA) for increased security. For users with this feature
24+
enabled, GitHub.com will prompt for a 2FA code in addition to a username and
25+
password during authentication. We’ve also rolled out some improvements to the
26+
API to ensure that 2FA requirements in the API are consistent with GitHub.com.&lt;/p&gt;
27+
28+
&lt;h2 id="authenticating-with-the-api"&gt;Authenticating with the API&lt;/h2&gt;
29+
30+
&lt;p&gt;For users without 2FA enabled, and for applications using the &lt;a href="/v3/oauth/#web-application-flow"&gt;OAuth web
31+
flow&lt;/a&gt; for authentication, everything is
32+
business as usual. You’ll continue to authenticate with the API just as you
33+
always have. (That was easy.)&lt;/p&gt;
34+
35+
&lt;p&gt;If you enable 2FA &lt;em&gt;and&lt;/em&gt; use Basic Authentication to access the API, we’re
36+
providing multiple options to make the flow simple and easy.&lt;/p&gt;
37+
38+
&lt;h2 id="basic-authentication-and-2fa"&gt;Basic Authentication and 2FA&lt;/h2&gt;
39+
40+
&lt;h3 id="personal-access-tokens"&gt;Personal Access Tokens&lt;/h3&gt;
41+
42+
&lt;p&gt;Personal access tokens provide the simplest option for using 2FA with Basic
43+
Authentication. You can create these tokens via the &lt;a href="https://github.com/settings/applications"&gt;application settings page
44+
on GitHub.com&lt;/a&gt;, and you can revoke
45+
them at any time. For more information about authenticating to the API with
46+
personal access tokens, be sure to check out our &lt;a href="https://help.github.com/articles/creating-an-access-token-for-command-line-use"&gt;help article on the
47+
topic&lt;/a&gt;.&lt;/p&gt;
48+
49+
&lt;h3 id="tightly-integrated-2fa"&gt;Tightly-integrated 2FA&lt;/h3&gt;
50+
51+
&lt;p&gt;For developers wishing to integrate GitHub 2FA directly into their application,
52+
the API’s Basic Authentication now supports the &lt;a href="/v3/auth/#working-with-two-factor-authentication"&gt;ability to send the user’s 2FA
53+
code&lt;/a&gt;, in addition to the username and password.&lt;/p&gt;
54+
55+
&lt;h2 id="were-here-to-help"&gt;We’re here to help&lt;/h2&gt;
56+
57+
&lt;p&gt;We think GitHub users are going to love the additional security provided by
58+
two-factor authentication. As always, if you have any questions or feedback,
59+
&lt;a href="https://github.com/contact?form%5Bsubject%5D=2FA+and+the+API"&gt;let us know&lt;/a&gt;. We’re here to help!&lt;/p&gt;</content>
60+
</entry>
1261
<entry>
1362
<id>tag:developer.github.com,2013-08-20:/changes/2013-08-20-search-api-improvements/</id>
1463
<title type="html">Improvements to the Search API</title>
@@ -283,26 +332,6 @@ but we can’t wait to see what others can do with this information.&lt;/p&gt;
283332
&lt;li&gt;&lt;strong&gt;&lt;a href="/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else"&gt;Participation&lt;/a&gt;&lt;/strong&gt;&lt;/li&gt;
284333
&lt;li&gt;&lt;strong&gt;&lt;a href="/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day"&gt;Punch Card&lt;/a&gt;&lt;/strong&gt;&lt;/li&gt;
285334
&lt;/ul&gt;&lt;p&gt;Enjoy!&lt;/p&gt;</content>
286-
</entry>
287-
<entry>
288-
<id>tag:developer.github.com,2013-04-30:/changes/2013-04-30-statuses-for-branches-and-tags/</id>
289-
<title type="html">Commit Statuses Now Available for Branches and Tags</title>
290-
<published>2013-04-30T04:00:00Z</published>
291-
<updated>2013-04-30T04:00:00Z</updated>
292-
<author>
293-
<name>foca</name>
294-
<uri>https://github.com/technoweenie</uri>
295-
</author>
296-
<link rel="alternate" href="http://developer.github.com/changes/2013-04-30-statuses-for-branches-and-tags/" />
297-
<content type="html">&lt;p&gt;Last week we announced &lt;a href="https://github.com/blog/1484-check-the-status-of-your-branches"&gt;support for build statuses in the branches page&lt;/a&gt;.
298-
Now we are extending this to the API. The &lt;a href="http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref"&gt;API endpoint for commit statuses&lt;/a&gt;
299-
has been extended to allow branch and tag names, as well as commit SHAs.&lt;/p&gt;
300-
301-
&lt;pre class="terminal"&gt;
302-
curl https://api.github.com/repos/rails/rails/statuses/3-2-stable
303-
&lt;/pre&gt;
304-
305-
&lt;p&gt;Enjoy.&lt;/p&gt;</content>
306335
</entry>
307336
<entry>
308337
<id>tag:developer.github.com,2013-04-30:/changes/2013-04-30-improved-submodule-support-in-repository-contents-api/</id>
@@ -343,6 +372,26 @@ curl https://api.github.com/repos/jquery/jquery/contents/test/qunit
343372

344373
&lt;p&gt;If you have any questions or feedback, please drop us a line at
345374
&lt;a href="mailto:[email protected]?subject=Submodules%20in%20Repository%20Contents%20API"&gt;[email protected]&lt;/a&gt;.&lt;/p&gt;</content>
375+
</entry>
376+
<entry>
377+
<id>tag:developer.github.com,2013-04-30:/changes/2013-04-30-statuses-for-branches-and-tags/</id>
378+
<title type="html">Commit Statuses Now Available for Branches and Tags</title>
379+
<published>2013-04-30T04:00:00Z</published>
380+
<updated>2013-04-30T04:00:00Z</updated>
381+
<author>
382+
<name>foca</name>
383+
<uri>https://github.com/technoweenie</uri>
384+
</author>
385+
<link rel="alternate" href="http://developer.github.com/changes/2013-04-30-statuses-for-branches-and-tags/" />
386+
<content type="html">&lt;p&gt;Last week we announced &lt;a href="https://github.com/blog/1484-check-the-status-of-your-branches"&gt;support for build statuses in the branches page&lt;/a&gt;.
387+
Now we are extending this to the API. The &lt;a href="http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref"&gt;API endpoint for commit statuses&lt;/a&gt;
388+
has been extended to allow branch and tag names, as well as commit SHAs.&lt;/p&gt;
389+
390+
&lt;pre class="terminal"&gt;
391+
curl https://api.github.com/repos/rails/rails/statuses/3-2-stable
392+
&lt;/pre&gt;
393+
394+
&lt;p&gt;Enjoy.&lt;/p&gt;</content>
346395
</entry>
347396
<entry>
348397
<id>tag:developer.github.com,2013-04-25:/changes/2013-04-25-deprecating-merge-commit-sha/</id>
@@ -982,52 +1031,4 @@ something unique to your application.&lt;/p&gt;
9821031
&lt;p&gt;If you have any questions or feedback, please drop us a line at
9831032
&lt;a href="mailto:[email protected]?subject=API%20Rate%20limit"&gt;[email protected]&lt;/a&gt;.&lt;/p&gt;</content>
9841033
</entry>
985-
<entry>
986-
<id>tag:developer.github.com,2012-09-28:/changes/2012-9-28-auto-init-for-repositories/</id>
987-
<title type="html">Initialize a repository when creating</title>
988-
<published>2012-09-28T04:00:00Z</published>
989-
<updated>2012-09-28T04:00:00Z</updated>
990-
<author>
991-
<name>pengwynn</name>
992-
<uri>https://github.com/technoweenie</uri>
993-
</author>
994-
<link rel="alternate" href="http://developer.github.com/changes/2012-9-28-auto-init-for-repositories/" />
995-
<content type="html">&lt;p&gt;Today we’ve made it easier to add commits to a repository via the GitHub API.
996-
Until now, you could &lt;a href="/v3/repos/#create"&gt;create a repository&lt;/a&gt;, but you would
997-
need to initialize it locally via your Git client before adding any commits via
998-
the API.&lt;/p&gt;
999-
1000-
&lt;p&gt;Now you can optionally init a repository when it’s created by sending &lt;code&gt;true&lt;/code&gt;
1001-
for the &lt;code&gt;auto_init&lt;/code&gt; parameter:&lt;/p&gt;
1002-
1003-
&lt;pre class="terminal"&gt;
1004-
curl -i -u pengwynn \
1005-
-d '{"name": "create-repo-test", "auto_init": true}' \
1006-
https://api.github.com/user/repos
1007-
&lt;/pre&gt;
1008-
1009-
&lt;p&gt;The resulting repository will have a README stub and an initial commit.&lt;/p&gt;
1010-
1011-
&lt;p&gt;&lt;img src="/images/posts/create-repo-init.png" alt="create repo screenshot"&gt;&lt;/p&gt;
1012-
1013-
&lt;h3 id="gitignore-templates"&gt;.gitignore templates&lt;/h3&gt;
1014-
1015-
&lt;p&gt;Along with this change, you can set up your &lt;code&gt;.gitignore&lt;/code&gt; template by passing
1016-
the basename of any template in the &lt;a href="https://github.com/github/gitignore"&gt;GitHub gitignore templates
1017-
project&lt;/a&gt;.&lt;/p&gt;
1018-
1019-
&lt;pre class="terminal"&gt;
1020-
curl -i -u pengwynn \
1021-
-d '{"name": "create-repo-test", "auto_init": true, \
1022-
"gitignore_template": "Haskell"}' \
1023-
https://api.github.com/user/repos
1024-
&lt;/pre&gt;
1025-
1026-
&lt;p&gt;As the &lt;a href="/v3/repos/#create"&gt;docs point out&lt;/a&gt;, the &lt;code&gt;gitignore_template&lt;/code&gt; parameter
1027-
is ignored if &lt;code&gt;auto_init&lt;/code&gt; is not present and &lt;code&gt;true&lt;/code&gt;.&lt;/p&gt;
1028-
1029-
&lt;p&gt;If you have any questions or feedback, drop us a line at
1030-
&lt;a href="https://github.com/c"&gt;https://github.com/contact&lt;/a&gt;, &lt;a href="mailto:[email protected]"&gt;[email protected]&lt;/a&gt;, or
1031-
&lt;a href="https://twitter.com/githubapi"&gt;@GitHubAPI&lt;/a&gt;.&lt;/p&gt;</content>
1032-
</entry>
10331034
</feed>

‎changes/2012-10-14-rate-limit-changes/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
8787
<li><a href="/v3/media/">Media Types</a></li>
8888
<li><a href="/v3/meta/">Meta</a></li>
8989
<li><a href="/v3/oauth/">OAuth</a></li>
90+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
9091
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
9192
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
9293
</ul>

‎changes/2012-10-17-org-members-redirection/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
8989
<li><a href="/v3/media/">Media Types</a></li>
9090
<li><a href="/v3/meta/">Meta</a></li>
9191
<li><a href="/v3/oauth/">OAuth</a></li>
92+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
9293
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
9394
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
9495
</ul>

‎changes/2012-10-24-set-default-branch/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
8383
<li><a href="/v3/media/">Media Types</a></li>
8484
<li><a href="/v3/meta/">Meta</a></li>
8585
<li><a href="/v3/oauth/">OAuth</a></li>
86+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
8687
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
8788
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
8889
</ul>

‎changes/2012-10-26-notifications-api/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
130130
<li><a href="/v3/media/">Media Types</a></li>
131131
<li><a href="/v3/meta/">Meta</a></li>
132132
<li><a href="/v3/oauth/">OAuth</a></li>
133+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
133134
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
134135
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
135136
</ul>

‎changes/2012-10-31-gist-comment-uris/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
7575
<li><a href="/v3/media/">Media Types</a></li>
7676
<li><a href="/v3/meta/">Meta</a></li>
7777
<li><a href="/v3/oauth/">OAuth</a></li>
78+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
7879
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
7980
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
8081
</ul>

‎changes/2012-11-27-forking-to-organizations/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
9494
<li><a href="/v3/media/">Media Types</a></li>
9595
<li><a href="/v3/meta/">Meta</a></li>
9696
<li><a href="/v3/oauth/">OAuth</a></li>
97+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
9798
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
9899
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
99100
</ul>

‎changes/2012-11-29-gitignore-templates/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
118118
<li><a href="/v3/media/">Media Types</a></li>
119119
<li><a href="/v3/meta/">Meta</a></li>
120120
<li><a href="/v3/oauth/">OAuth</a></li>
121+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
121122
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
122123
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
123124
</ul>

‎changes/2012-12-04-List-comments-for-repo/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
9090
<li><a href="/v3/media/">Media Types</a></li>
9191
<li><a href="/v3/meta/">Meta</a></li>
9292
<li><a href="/v3/oauth/">OAuth</a></li>
93+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
9394
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
9495
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
9596
</ul>

‎changes/2012-12-06-create-authorization-for-app/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
9797
<li><a href="/v3/media/">Media Types</a></li>
9898
<li><a href="/v3/meta/">Meta</a></li>
9999
<li><a href="/v3/oauth/">OAuth</a></li>
100+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
100101
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
101102
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
102103
</ul>

0 commit comments

Comments
 (0)