team_slug parameter
Delete a discussion comment
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
Path Parameters
Response
204
Response
Response
Path Parameters
List team members
Team members will include the members of child teams.
To list members in a team, the team must be visible to the authenticated user.
Query Parameters
Filters members returned by their role in the team. Can be one of:
* member
- normal members of the team.
* maintainer
- team maintainers.
* all
- all members of the team.
Allowed values:membermaintainerall
Default:all
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
Simple User
Example:octocat
Example:1
Example:MDQ6VXNlcjE=
Example:https://github.com/images/error/octocat_happy.gif
Example:41d064eb2195891e12d0413f63227ea7
Example:https://api.github.com/users/octocat
Example:https://github.com/octocat
Example:https://api.github.com/users/octocat/followers
Example:https://api.github.com/users/octocat/following{/other_user}
Example:https://api.github.com/users/octocat/gists{/gist_id}
Example:https://api.github.com/users/octocat/starred{/owner}{/repo}
Example:https://api.github.com/users/octocat/subscriptions
Example:https://api.github.com/users/octocat/orgs
Example:https://api.github.com/users/octocat/repos
Example:https://api.github.com/users/octocat/events{/privacy}
Example:https://api.github.com/users/octocat/received_events
Example:User
Example:"2020-07-09T00:17:55Z"
Path Parameters
Query Parameters
Get team membership for a user
Team members will include the members of child teams.
To get a user’s membership with a team, the team must be visible to the authenticated user.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Note:
The response contains the state
of the membership and the member’s role
.
The role
for organization owners is set to maintainer
. For more information about maintainer
roles, see see Create a team.
Path Parameters
team_slug parameter
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
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
team_slug parameter
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