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 Nov 1, 2017. It is now read-only.
Copy file name to clipboardExpand all lines: content/changes/2014-09-23-one-more-week-before-the-add-team-member-api-breaking-change.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ created_at: 2014-09-23
5
5
author_name:jakeboxer
6
6
---
7
7
8
-
**Update:2014-09-30:** In response to feedback from developers, we're delaying the breaking change to the["Add team member" API][add-team-member] until Monday,**October 6, 2014**. The change will go into effect for all requests on that date.
8
+
**UPDATE (2014-09-30):** In response to feedback from developers, we're delaying the breaking change to the["Add team member" API][add-team-member] until Monday,**October 6, 2014**. The change will go into effect for all requests on that date.
9
9
10
10
Starting October 6, if you use[the "Add team member" API][add-team-member] to add a user to a team and that user isn't already on another team in your organization, the request will fail. To avoid this, be sure to use the[the "Add team membership" API][add-team-membership].
**UPDATE (2014-12-12):** The[List your organizations][list-your-organizations] API is now included in this preview as well.
8
+
7
9
We have some upcoming changes that will affect the way organization members and repositories are managed. The most important changes are:
8
10
9
11
- The Owners team will no longer be special.
10
12
- The[List your repositories][list-your-repos] API will include organization-owned repositories.
11
13
- The[List user organizations][list-user-organizations] API will only include public organization memberships.
14
+
- The[List your organizations][list-your-organizations] API will require`user` scope or`read:org` scope.
12
15
13
16
##What's happening to the Owners team?
14
17
@@ -58,6 +61,20 @@ Soon, this API will only return public organization memberships.
58
61
59
62
If your app uses the[List user organizations][list-user-organizations] API to fetch all of the organization memberships (public and private) for the authenticated user, you'll need to update your app to use the[List your organizations][list-your-organizations] API instead. The[List your organizations][list-your-organizations] API returns all organizations (public and private) that your app is authorized to access.
60
63
64
+
##What's happening to the "List your organizations" API?
65
+
66
+
OAuth requests will soon require minimum[scopes][] in order to access the[List your organizations][list-your-organizations] API.
67
+
68
+
Currently, the API response always includes your[public organization memberships][public-org-membership], regardless of the OAuth scopes associated with your request. If you have`user`,`read:org`,`write:org`, or`admin:org` scope, the response also includes your private organization memberships.
69
+
70
+
Soon, this API will only return organizations that your authorization allows you to operate on in some way (e.g., you can list teams with`read:org` scope, you can publicize your organization membership with`user` scope, etc.). Therefore, this API will require at least`user` or`read:org` scope. (`write:org` and`admin:org` scope implicitly include`read:org` scope.) OAuth requests with insufficient scope will receive a`403 Forbidden` response.
71
+
72
+
###What should you do?
73
+
74
+
If you[authenticate via username and password][username-password-authn], you are not affected by this change.
75
+
76
+
If your app only needs to fetch the user's public organization memberships, you should use the[List user organizations][list-user-organizations] API instead. Since that API only returns public information, it does not require any scopes.
77
+
61
78
##Preview period
62
79
63
80
Starting**today**, these new APIs are available for developers to preview. We expect the preview period to last for four weeks. (Stay tuned to the developer blog for updates.) At the end of the preview period, these additions will become official components of the GitHub API.
@@ -86,3 +103,5 @@ If you have any questions or feedback, please [get in touch with us][contact]!
Copy file name to clipboardExpand all lines: content/v3/orgs.md
+16-1Lines changed: 16 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,22 @@ List organizations for the authenticated user.
13
13
14
14
###OAuth scope requirements
15
15
16
-
When using[OAuth](/v3/oauth/#scopes), authorizations must include`user` scope or`read:org` scope.
16
+
Currently,[OAuth](/v3/oauth/#scopes) requests always receive the user's[public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership), regardless of the OAuth scopes associated with the request. If the OAuth authorization has`user` or`read:org` scope, the response also includes private organization memberships.
17
+
18
+
With the new Organization Permissions API (described below), this method will only return organizations that your authorization allows you to operate on in some way (e.g., you can list teams with`read:org` scope, you can publicize your organization membership with`user` scope, etc.). Therefore, this API will require at least`user` or`read:org` scope. OAuth requests with insufficient scope will receive a`403 Forbidden` response.
19
+
20
+
<divclass="alert">
21
+
<p>
22
+
The Organization Permissions API is currently available for developers to preview.
23
+
During the preview period, the API may change without notice.
24
+
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
25
+
</p>
26
+
27
+
<p>
28
+
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header: