memberships

Overview

Name	memberships
Type	Resource
Id	github.orgs.memberships

Fields

Name	Datatype	Description
organization_url	string
permissions	object
role	string	The user's membership type in the organization.
state	string	The state of the member in the organization. The pending state indicates the user has not yet accepted an invitation.
url	string
user	object	A GitHub user.
organization	object	A GitHub organization.

Methods

Name	Accessible by	Required Params	Description
get_membership_for_authenticated_user	SELECT	org	If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.
get_membership_for_user	SELECT	org, username	In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
list_memberships_for_authenticated_user	SELECT		Lists all of the authenticated user's organization memberships.
remove_membership_for_user	DELETE	org, username	In order to remove a user's membership with an organization, the authenticated user must be an organization owner. If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
check_membership_for_user	EXEC	org, username	Check if a user is, publicly or privately, a member of the organization.
check_public_membership_for_user	EXEC	org, username	Check if the provided user is a public member of the organization.
remove_public_membership_for_authenticated_user	EXEC	org, username	Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
set_membership_for_user	EXEC	org, username	Only authenticated organization owners can add a member to the organization or update the member's role. If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation. Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent. Rate limits To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
set_public_membership_for_authenticated_user	EXEC	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 verbs."
update_membership_for_authenticated_user	EXEC	org, data__state	Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.