team_slug parameter
Add or update team membership for a user
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a 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 Enterprise Server 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 Enterprise Server.”
An organization owner can add someone who is not part of the team’s organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the “pending” state until the person accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team.
If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
Note: You can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Path Parameters
Body
application/json
Body
The role that this user should have in the team. Can be one of:
* member
- a normal member of the team.
* maintainer
- a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team’s name and description.
Allowed values:membermaintainer
Default:member
Response
application/json
Response
Response
Team Membership
Team Membership
The role of the user in the team.
Allowed values:membermaintainer
Default:member
Example:member
The state of the user’s membership in the team.
Allowed values:activepending
Path Parameters
Body
Remove team membership for a user
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 membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership 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 Enterprise Server 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 Enterprise Server.”
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Path Parameters
team_slug parameter
Response
Response
Response
Path Parameters
List team projects
Lists the organization projects for a team.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/projects
.
Query Parameters
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
team_slug parameter
Response
200 application/json
Response
Response
A team’s access to a project.
Simple User
Show Child Parameters
The organization permission for this project. Only present when owner is an organization.
Whether the project is private or not. Only present when owner is an organization.
Show Child Parameters
Path Parameters
Query Parameters
Check team permissions for a project
Checks whether a team has read
, write
, or admin
permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}
.
Path Parameters
team_slug parameter
Response
application/json
Response
Response
Team Project
A team’s access to a project.
Simple User
Show Child Parameters
The organization permission for this project. Only present when owner is an organization.
Whether the project is private or not. Only present when owner is an organization.
Show Child Parameters
Path Parameters
Add or update team project permissions
Adds an organization project to a team. To add a project to a team or update the team’s permission on a project, the authenticated user must have admin
permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}
.
Path Parameters
team_slug parameter
Body
application/json
Body
The permission to grant to the team for this project. Can be one of:
* read
- team members can read, but not write to or administer this project.
* write
- team members can read and write, but not administer this project.
* admin
- team members can read, write and administer this project.
Default: the team’s permission
attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
Allowed values:readwriteadmin
Response
Response
Response