Add team member (Legacy)

Deprecated

PUT

/teams/{team_id}/members/{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."

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/teams//members/'

Response Example

204 - Example 1

{}

Request

Path Params

team_id

integer

required

The unique identifier of the team.

username

string

required

The handle for the GitHub user account.

Responses

🟢204Response

application/json

Body

object {0}

🟠403403

🟠404Not Found if team synchronization is set up

🟠422Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization

Modified at 2023-08-15 02:59:30

Get team member (Legacy)

Remove team membership for a user (Legacy)