members

Overview

Name	members
Type	Resource
Id	github.teams.members

Fields

Name	Datatype
id	integer
name	string
avatar_url	string
email	string
events_url	string
followers_url	string
following_url	string
gists_url	string
gravatar_id	string
html_url	string
login	string
node_id	string
organizations_url	string
received_events_url	string
repos_url	string
site_admin	boolean
starred_at	string
starred_url	string
subscriptions_url	string
type	string
url	string

Methods

Name	Accessible by	Required Params	Description
list_members_in_org	SELECT	org, team_slug	Team members will include the members of child teams. To list members in a team, the team must be visible to the authenticated user.
list_members_legacy	SELECT	team_id	Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint. Team members will include the members of child teams.
remove_member_legacy	DELETE	team_id, username	The "Remove team member" endpoint (described below) is deprecated. We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."
add_member_legacy	EXEC	team_id, username	The "Add team member" endpoint (described below) is deprecated. We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
get_member_legacy	EXEC	team_id, username	The "Get team member" endpoint (described below) is deprecated. We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships. To list members in a team, the team must be visible to the authenticated user.