public_members

Creates, updates, deletes, gets or lists a public_members resource.

Overview

Name	public_members
Type	Resource
Id	github.orgs.public_members

Fields

The following fields are returned by SELECT queries:

list_public_members

Response

Name	Datatype	Description
id	integer (int64)
name	string
gravatar_id	string	(example: 41d064eb2195891e12d0413f63227ea7)
node_id	string	(example: MDQ6VXNlcjE=)
avatar_url	string (uri)	(example: https://github.com/images/error/octocat_happy.gif)
email	string
events_url	string	(example: https://api.github.com/users/octocat/events{/privacy})
followers_url	string (uri)	(example: https://api.github.com/users/octocat/followers)
following_url	string	(example: https://api.github.com/users/octocat/following{/other_user})
gists_url	string	(example: https://api.github.com/users/octocat/gists{/gist_id})
html_url	string (uri)	(example: https://github.com/octocat)
login	string	(example: octocat)
organizations_url	string (uri)	(example: https://api.github.com/users/octocat/orgs)
received_events_url	string (uri)	(example: https://api.github.com/users/octocat/received_events)
repos_url	string (uri)	(example: https://api.github.com/users/octocat/repos)
site_admin	boolean
starred_at	string	(example: "2020-07-09T00:17:55Z")
starred_url	string	(example: https://api.github.com/users/octocat/starred{/owner}{/repo})
subscriptions_url	string (uri)	(example: https://api.github.com/users/octocat/subscriptions)
type	string	(example: User)
url	string (uri)	(example: https://api.github.com/users/octocat)
user_view_type	string	(example: public)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_public_members	select	org	per_page, page	Members of an organization can choose to have their membership publicized or not.
set_public_membership_for_authenticated_user	replace	org, username		The user can publicize their own membership. (A user cannot publicize the membership for another user.) Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."
remove_public_membership_for_authenticated_user	delete	org, username		Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
check_public_membership_for_user	exec	org, username		Check if the provided user is a public member of the organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
username	string	The handle for the GitHub user account.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_public_members

Members of an organization can choose to have their membership publicized or not.

SELECT
id,
name,
gravatar_id,
node_id,
avatar_url,
email,
events_url,
followers_url,
following_url,
gists_url,
html_url,
login,
organizations_url,
received_events_url,
repos_url,
site_admin,
starred_at,
starred_url,
subscriptions_url,
type,
url,
user_view_type
FROM github.orgs.public_members
WHERE org = '{{ org }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

REPLACE examples

set_public_membership_for_authenticated_user

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

REPLACE github.orgs.public_members
SET 
-- No updatable properties
WHERE 
org = '{{ org }}' --required
AND username = '{{ username }}' --required;

DELETE examples

remove_public_membership_for_authenticated_user

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

DELETE FROM github.orgs.public_members
WHERE org = '{{ org }}' --required
AND username = '{{ username }}' --required
;

Lifecycle Methods

check_public_membership_for_user

Check if the provided user is a public member of the organization.

EXEC github.orgs.public_members.check_public_membership_for_user 
@org='{{ org }}' --required, 
@username='{{ username }}' --required
;