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

Commit c4a8f9b

Browse files
tclemtclem
committed
Post on oauth changes
1 parent 94543b9 commit c4a8f9b

File tree

11 files changed

+572
-185
lines changed

11 files changed

+572
-185
lines changed

‎changes.atom‎

Lines changed: 124 additions & 97 deletions
Large diffs are not rendered by default.

‎changes/2013-10-04-oauth-changes-coming/index.html‎

Lines changed: 304 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,304 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5+
<meta http-equiv="Content-Language" content="en-us" />
6+
<meta http-equiv="imagetoolbar" content="false" />
7+
<meta name="MSSmartTagsPreventParsing" content="true" />
8+
<title>OAuth changes coming</title>
9+
<link rel="alternate" type="application/atom+xml" title="API Changes" href="/changes.atom" />
10+
<link href="/css/reset.css" rel="stylesheet" type="text/css" />
11+
<link href="/css/960.css" rel="stylesheet" type="text/css" />
12+
<link href="/css/uv_active4d.css" rel="stylesheet" type="text/css" />
13+
<link href="/shared/css/documentation.css" media="screen" rel="stylesheet" type="text/css">
14+
<link href="/shared/css/pygments.css" media="screen" rel="stylesheet" type="text/css">
15+
<script src="/shared/js/jquery.js" type="text/javascript"></script>
16+
<script src="/shared/js/documentation.js" type="text/javascript"></script>
17+
</head>
18+
<body class="api">
19+
<div id="header-wrapper">
20+
<div id="header">
21+
<div>
22+
<a class="logo" href="/"><img src="/images/logo_developer.png" height="45" alt="GitHub:Developer" /></a>
23+
<ul class="nav">
24+
<li class="api-status"></li>
25+
<li><a href="/v3/">API v3</a></li>
26+
<li><a href="/changes/">Changes</a></li>
27+
<li><a
28+
href="https://github.com/contact">Support</a></li>
29+
<li><a href="/changes.atom">
30+
<img src="/images/feed-icon-28x28.png" width="16" height="16" alt="GitHub API Changes Feed" />
31+
</a></li>
32+
</ul>
33+
</div>
34+
</div><!-- #header -->
35+
</div><!-- #header-wrapper -->
36+
37+
<div id="wrapper">
38+
<div class="content">
39+
<div class="change" id="/changes/2013-10-04-oauth-changes-coming/">
40+
<h2 class="title">
41+
<a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming</a>
42+
</h2>
43+
44+
<div class="meta">
45+
<ul>
46+
<li class="published">
47+
<span class="octicon octicon-calendar"></span>
48+
October 4, 2013
49+
50+
</li>
51+
<li class="who_when">
52+
<img height="16" width="16" src="https://secure.gravatar.com/avatar/2f4861b27dc35663ed271d39f5358261?s=20&d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png" />
53+
<a href="https://github.com/tclem">tclem</a>
54+
</li>
55+
</ul>
56+
</div>
57+
58+
59+
<p>Starting today, we are returning granted scopes as part of the
60+
<a href="/v3/oauth/#github-redirects-back-to-your-site">access_token response</a>.
61+
For example, if you are making a POST with the <code>application/json</code>
62+
mime-type you’ll see an additional field for the granted scopes.</p>
63+
64+
<pre class="highlight">
65+
<code class="language-javascript"><span class="p">{</span>
66+
<span class="s2">"access_token"</span><span class="o">:</span><span class="s2">"e72e16c7e42f292c6912e7710c838347ae178b4a"</span><span class="p">,</span>
67+
<span class="s2">"scope"</span><span class="o">:</span><span class="s2">"repo,gist"</span><span class="p">,</span>
68+
<span class="s2">"token_type"</span><span class="o">:</span><span class="s2">"bearer"</span>
69+
<span class="p">}</span></code>
70+
</pre>
71+
72+
<p>Right now, these scopes will be identical to what you requested, but we
73+
are moving towards a feature set that will allow GitHub users to edit
74+
their scopes, effectively granting your application less access than you
75+
originally requested. You should be aware of this possibility and adjust
76+
your application behavior accordingly.</p>
77+
78+
<p>Some things to watch out for and keep in mind:</p>
79+
80+
<ul>
81+
<li>
82+
<p>Most third party applications using GitHub OAuth to identify users have
83+
the best success in adoption by starting out with a request for the
84+
minimum access that the application can possibly get away with.
85+
Something like no scopes or just <code>user:email</code> is very sane.</p>
86+
</li>
87+
<li>
88+
<p>It is important to handle the error cases where a users chooses to
89+
grant you less access than you originally requested. Now that we are
90+
surfacing the granted scopes on the access_token response, applications
91+
can warn or otherwise communicate with their users that they will see
92+
reduced functionality or be unable to perform some actions.</p>
93+
</li>
94+
<li>
95+
<p>Applications can always send users back through the flow again to get
96+
additional permission, but don’t forget that users can always say no.</p>
97+
</li>
98+
</ul>
99+
</div>
100+
101+
</div>
102+
103+
<div id="js-sidebar" class="sidebar-shell">
104+
<div class="js-toggle-list sidebar-module expandable">
105+
<ul>
106+
<li class="js-topic">
107+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overview</a></h3>
108+
<ul class="js-guides">
109+
<li><a href="/v3/libraries/">Libraries</a></li>
110+
<li><a href="/v3/media/">Media Types</a></li>
111+
<li><a href="/v3/oauth/">OAuth</a></li>
112+
<li><a href="/v3/auth/">Other Authentication Methods</a></li>
113+
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
114+
</ul>
115+
</li>
116+
<li class="js-topic">
117+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/guides/">Guides</a></h3>
118+
<ul class="js-guides">
119+
<li><a href="/guides/getting-started/">Getting Started</a></li>
120+
<li><a href="/guides/basics-of-authentication/">Basics of Authentication</a></li>
121+
<li><a href="/guides/rendering-data-as-graphs/">Rendering Data as Graphs</a></li>
122+
<li><a href="/guides/working-with-comments/">Working with Comments</a></li>
123+
</ul>
124+
</li>
125+
<li class="js-topic">
126+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/activity/">Activity</a></h3>
127+
<ul class="js-guides">
128+
<li><a href="/v3/activity/events/">Events</a></li>
129+
<li><a href="/v3/activity/events/types/">Event Types</a></li>
130+
<li><a href="/v3/activity/feeds/">Feeds</a></li>
131+
<li><a href="/v3/activity/notifications/">Notifications</a></li>
132+
<li><a href="/v3/activity/starring/">Starring</a></li>
133+
<li><a href="/v3/activity/watching/">Watching</a></li>
134+
</ul>
135+
</li>
136+
<li class="js-topic">
137+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/gists/">Gists</a></h3>
138+
<ul class="js-guides">
139+
<li><a href="/v3/gists/comments/">Comments</a></li>
140+
</ul>
141+
</li>
142+
<li class="js-topic">
143+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/git/">Git Data</a></h3>
144+
<ul class="js-guides">
145+
<li><a href="/v3/git/blobs/">Blobs</a></li>
146+
<li><a href="/v3/git/commits/">Commits</a></li>
147+
<li><a href="/v3/git/refs/">References</a></li>
148+
<li><a href="/v3/git/tags/">Tags</a></li>
149+
<li><a href="/v3/git/trees/">Trees</a></li>
150+
</ul>
151+
</li>
152+
<li class="js-topic">
153+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/issues/">Issues</a></h3>
154+
<ul class="js-guides">
155+
<li><a href="/v3/issues/assignees/">Assignees</a></li>
156+
<li><a href="/v3/issues/comments/">Comments</a></li>
157+
<li><a href="/v3/issues/events/">Events</a></li>
158+
<li><a href="/v3/issues/labels/">Labels</a></li>
159+
<li><a href="/v3/issues/milestones/">Milestones</a></li>
160+
</ul>
161+
</li>
162+
<li class="js-topic">
163+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/misc/">Miscellaneous</a></h3>
164+
<ul class="js-guides">
165+
<li><a href="/v3/emojis/">Emojis</a></li>
166+
<li><a href="/v3/gitignore/">Gitignore</a></li>
167+
<li><a href="/v3/markdown/">Markdown</a></li>
168+
<li><a href="/v3/meta/">Meta</a></li>
169+
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
170+
</ul>
171+
</li>
172+
<li class="js-topic">
173+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/orgs/">Orgs</a></h3>
174+
<ul class="js-guides">
175+
<li><a href="/v3/orgs/members/">Members</a></li>
176+
<li><a href="/v3/orgs/teams/">Teams</a></li>
177+
</ul>
178+
</li>
179+
<li class="js-topic">
180+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/pulls/">Pull Requests</a></h3>
181+
<ul class="js-guides">
182+
<li><a href="/v3/pulls/comments/">Review Comments</a></li>
183+
</ul>
184+
</li>
185+
<li class="js-topic">
186+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/repos/">Repositories</a></h3>
187+
<ul class="js-guides">
188+
<li><a href="/v3/repos/collaborators/">Collaborators</a></li>
189+
<li><a href="/v3/repos/comments/">Comments</a></li>
190+
<li><a href="/v3/repos/commits/">Commits</a></li>
191+
<li><a href="/v3/repos/contents/">Contents</a></li>
192+
<li><a href="/v3/repos/downloads/">Downloads</a></li>
193+
<li><a href="/v3/repos/forks/">Forks</a></li>
194+
<li><a href="/v3/repos/keys/">Keys</a></li>
195+
<li><a href="/v3/repos/hooks/">Hooks</a></li>
196+
<li><a href="/v3/repos/merging/">Merging</a></li>
197+
<li><a href="/v3/repos/releases/">Releases</a></li>
198+
<li><a href="/v3/repos/statistics/">Statistics</a></li>
199+
<li><a href="/v3/repos/statuses/">Statuses</a></li>
200+
</ul>
201+
</li>
202+
<li class="js-topic">
203+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/search/">Search</a></h3>
204+
<ul class="js-guides">
205+
<li><a href="/v3/search/#search-repositories">Repositories</a></li>
206+
<li><a href="/v3/search/#search-code">Code</a></li>
207+
<li><a href="/v3/search/#search-issues">Issues</a></li>
208+
<li><a href="/v3/search/#search-users">Users</a></li>
209+
<li><a href="/v3/search/legacy/">Legacy Search</a></li>
210+
</ul>
211+
</li>
212+
<li class="js-topic">
213+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/users/">Users</a></h3>
214+
<ul class="js-guides">
215+
<li><a href="/v3/users/emails/">Emails</a></li>
216+
<li><a href="/v3/users/followers/">Followers</a></li>
217+
<li><a href="/v3/users/keys/">Keys</a></li>
218+
</ul>
219+
</li>
220+
</ul>
221+
</div> <!-- /sidebar-module -->
222+
<div class="sidebar-module">
223+
<p>This website is a <a href="https://github.com/github/developer.github.com" target="_blank">public GitHub repository</a>. Please help us by forking the project and adding to it.</p>
224+
</div>
225+
</div><!-- /sidebar-shell -->
226+
227+
</div><!-- #wrapper -->
228+
229+
<div id="footer" >
230+
<div class="upper_footer">
231+
<div class="footer_inner clearfix">
232+
233+
<ul class="footer_nav">
234+
<h4>GitHub</h4>
235+
<li><a href="https://github.com/about">About</a></li>
236+
<li><a href="https://github.com/blog">Blog</a></li>
237+
<li><a href="https://github.com/features">Features</a></li>
238+
<li><a href="https://github.com/contact">Contact &amp; Support</a></li>
239+
<li><a href="https://github.com/training">Training</a></li>
240+
<li><a href="http://status.github.com/">Site Status</a></li>
241+
</ul>
242+
243+
<ul class="footer_nav">
244+
<h4>Tools</h4>
245+
<li><a href="http://mac.github.com/">GitHub for Mac</a></li>
246+
<li><a href="http://mobile.github.com/">Issues for iPhone</a></li>
247+
<li><a href="https://gist.github.com">Gist: Code Snippets</a></li>
248+
<li><a href="http://enterprise.github.com/">GitHub Enterprise</a></li>
249+
<li><a href="http://jobs.github.com/">Job Board</a></li>
250+
</ul>
251+
252+
<ul class="footer_nav">
253+
<h4>Extras</h4>
254+
<li><a href="http://shop.github.com/">GitHub Shop</a></li>
255+
<li><a href="http://octodex.github.com/">The Octodex</a></li>
256+
</ul>
257+
258+
<ul class="footer_nav">
259+
<h4>Documentation</h4>
260+
<li><a href="http://help.github.com/">GitHub Help</a></li>
261+
<li><a href="http://developer.github.com/">Developer API</a></li>
262+
<li><a href="http://github.github.com/github-flavored-markdown/">GitHub Flavored Markdown</a></li>
263+
<li><a href="http://pages.github.com/">GitHub Pages</a></li>
264+
</ul>
265+
266+
</div><!-- /.site -->
267+
</div><!-- /.upper_footer -->
268+
269+
<div class="lower_footer">
270+
<ul class="footer-cell">
271+
<li><a href="http://help.github.com/terms-of-service/">Terms of Service</a></li>
272+
<li><a href="http://help.github.com/privacy-policy/">Privacy</a></li>
273+
<li><a href="http://help.github.com/security/">Security</a></li>
274+
</ul>
275+
276+
<span class="footer-cell">
277+
<a href="https://github.com" class="mega-icon mega-icon-invertocat"></a>
278+
</span>
279+
280+
<span class="footer-cell">
281+
Design &copy; <span class="js-year">2013</span> GitHub, Inc. All rights reserved.
282+
<p>
283+
Except where otherwise noted, content on this site is licensed under a
284+
<a href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons CC-BY license</a>.
285+
</p>
286+
</span>
287+
</div>
288+
289+
</div><!-- /#footer -->
290+
<script type="text/javascript">
291+
var _gauges = _gauges || [];
292+
(function() {
293+
var t = document.createElement('script');
294+
t.type = 'text/javascript';
295+
t.async = true;
296+
t.id = 'gauges-tracker';
297+
t.setAttribute('data-site-id', '4f2038e0cb25bc1b55000003');
298+
t.src = '//secure.gaug.es/track.js';
299+
var s = document.getElementsByTagName('script')[0];
300+
s.parentNode.insertBefore(t, s);
301+
})();
302+
</script>
303+
</body>
304+
</html>

0 commit comments

Comments
 (0)