Skip to content

Commit de55dd9

Browse files
author
Peter Williams
committed
Updated members page and added a changes entry to reflect github/github#6584
1 parent 983f527 commit de55dd9

File tree

2 files changed

+23
-11
lines changed

2 files changed

+23
-11
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
kind: change
3+
title: Organization Members Resource Changes
4+
created_at: 2012-10-12
5+
author_name: pezra
6+
---
7+
8+
Requesting the [member list](/v3/orgs/members/index.html#members-list) of an organization of which you are not a member now redirects to the [public members list](v3/orgs/members/index.html#public-members-list). Requests to [membership check](/v3/orgs/members/index.html#check-membership) resources of an organization of which you are not a member are similarly redirected to the equivalent [public membership check](/v3/orgs/members/index.html#check-public-membership) unless it is a check about yourself, in which case it is treated as a request by a member.
9+
10+
The changes where made to clarify the purpose of these various resources. The `/orgs/{org}/members` resources are intended for use by members of the organization in question. The `/orgs/{org}/public_members` resources are intended for acquiring information about organizations of which you are not a member.

content/v3/orgs/members.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ title: Organization Members | GitHub API
77
* TOC
88
{:toc}
99

10-
## List members
10+
## Members list
1111

1212
List all users who are members of an organization. A member is a user
13-
that belongs to at least 1 team in the organization. If the authenticated user is
14-
also a member of this organization then both concealed and public
15-
members will be returned. Otherwise only public members are returned.
13+
that belongs to at least 1 team in the organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. If the reqeuster is not a member of the organization the query will be redirected to the [public members list](#public-members-list).
1614

1715
GET /orgs/:org/members
1816

@@ -21,25 +19,29 @@ members will be returned. Otherwise only public members are returned.
2119
<%= headers 200 %>
2220
<%= json(:user) { |h| [h] } %>
2321

24-
### Response if requester is not a organization member
22+
### Response if requester is not an organization member
2523

2624
<%= headers 302, "Location" => "https://api.github.com/orgs/github/public_members" %>
2725

28-
## Get member
26+
## Check membership
2927

3028
Check if a user is, publicly or privately, a member of the organization.
3129

3230
GET /orgs/:org/members/:user
3331

34-
### Response if user is a member
32+
### Response if requester is an organization member and user is a member
3533

3634
<%= headers 204 %>
3735

38-
### Response if user is not a member
36+
### Response if requester is an organization member and user is not a member
3937

4038
<%= headers 404 %>
4139

42-
### Response if requester is not a organization member
40+
### Response if requester is not an organization member and is inquiring about themselves
41+
42+
<%= headers 404 %>
43+
44+
### Response if requester is not an organization member
4345

4446
<%= headers 302, :Location => "https://api.github.com/orgs/github/public_members/pezra" %>
4547

@@ -59,7 +61,7 @@ they will no longer have any access to the organization's repositories.
5961

6062
<%= headers 204 %>
6163

62-
## List public members
64+
## Public members list
6365

6466
Members of an organization can choose to have their membership
6567
publicized or not.
@@ -71,7 +73,7 @@ publicized or not.
7173
<%= headers 200 %>
7274
<%= json(:user) { |h| [h] } %>
7375

74-
## Get if a user is a public member
76+
## Check public membership
7577

7678
GET /orgs/:org/public_members/:user
7779

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy