blocking

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

Overview

Name	blocking
Type	Resource
Id	github.orgs.blocking

Fields

The following fields are returned by SELECT queries:

list_blocked_users

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_blocked_users	select	org	per_page, page	List the users blocked by an organization.
check_blocked_user	exec	org, username		Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.
block_user	exec	org, username		Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
unblock_user	exec	org, username		Unblocks the given user on behalf of the specified 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_blocked_users

List the users blocked by an organization.

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.blocking
WHERE org = '{{ org }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

Lifecycle Methods

check_blocked_user

Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.

EXEC github.orgs.blocking.check_blocked_user 
@org='{{ org }}' --required, 
@username='{{ username }}' --required
;

block_user

Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.

EXEC github.orgs.blocking.block_user 
@org='{{ org }}' --required, 
@username='{{ username }}' --required
;

unblock_user

Unblocks the given user on behalf of the specified organization.

EXEC github.orgs.blocking.unblock_user 
@org='{{ org }}' --required, 
@username='{{ username }}' --required
;