REST-API-Endpunkte für Teammitglieder

Informationen zu Teammitgliedern

Diese Endpunkte sind nur für authentifizierte Mitglieder der Organisation des Teams verfügbar. OAuth-Zugriffstoken erfordern den read:org-Bereich. GitHub generiert den slug-Wert des Teams aus dem name-Wert des Teams.

Wenn pull- und push-Berechtigungen akzeptiert werden, werden sie den Lese- und Schreib-Rollen für ein Organisations-Repository zugeordnet. Weitere Informationen zu Repositoryrollen findest du unter Repositoryrollen für eine Organisation.

Note

Wenn du die Teamsynchronisierung für ein Team mit dem Identitätsanbieter (IdP) deiner Organisation eingerichtet hast, wird beim Versuch, die API für Änderungen an der Teammitgliedschaft zu verwenden, ein Fehler angezeigt. Wenn du über Zugriffsberechtigungen für die Verwaltung von Gruppenmitgliedschaften in deinem IdP verfügst, kannst du GitHub-Teammitgliedschaften über deinen Identitätsanbieter verwalten, der automatisch Teammitglieder in einer Organisation hinzufügt und entfernt. Weitere Informationen finden Sie unter Verwalten der Teamsynchronisierung für deine Organisation.

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.

Parameter für „List team members“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`team_slug` string Erforderlich The slug of the team name.

Abfrageparameter
Name, type, BESCHREIBUNG
`role` string Filters members returned by their role in the team. Standard: `all` Kann eine der Folgenden sein: `member`, `maintainer`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List team members“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List team members“

Anforderungsbeispiel

get/orgs/{org}/teams/{team_slug}/members

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/members

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

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 Create a team.

Parameter für „Get team membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`team_slug` string Erforderlich The slug of the team name.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Get team membership for a user“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	if user has no team membership

Codebeispiele für „Get team membership for a user“

Anforderungsbeispiel

get/orgs/{org}/teams/{team_slug}/memberships/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

Response if user is a team maintainer

Status: 200

{
  "url": "https://HOSTNAME/teams/1/memberships/octocat",
  "role": "maintainer",
  "state": "active"
}

Add or update team membership for a user

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

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}.

Parameter für „Add or update team membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`team_slug` string Erforderlich The slug of the team name.
`username` string Erforderlich The handle for the GitHub user account.

Textparameter
Name, type, BESCHREIBUNG
`role` string The role that this user should have in the team. Standard: `member` Kann eine der Folgenden sein: `member`, `maintainer`

HTTP-Antwortstatuscodes für „Add or update team membership for a user“

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden if team synchronization is set up
`422`	Unprocessable Entity if you attempt to add an organization to a team

Codebeispiele für „Add or update team membership for a user“

Anforderungsbeispiel

put/orgs/{org}/teams/{team_slug}/memberships/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \
  -d '{"role":"maintainer"}'

Response if user's membership with team is now pending

Status: 200

{
  "url": "https://HOSTNAME/teams/1/memberships/octocat",
  "role": "member",
  "state": "pending"
}

Remove team membership for a user

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.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

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}.

Parameter für „Remove team membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`team_slug` string Erforderlich The slug of the team name.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove team membership for a user“

Statuscode	BESCHREIBUNG
`204`	No Content
`403`	Forbidden if team synchronization is set up

Codebeispiele für „Remove team membership for a user“

Anforderungsbeispiel

delete/orgs/{org}/teams/{team_slug}/memberships/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

Response

Status: 204

List team members (Legacy)

Warning

Endpoint closing down notice: This endpoint route is closing down 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.

Parameter für „List team members (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.

Abfrageparameter
Name, type, BESCHREIBUNG
`role` string Filters members returned by their role in the team. Standard: `all` Kann eine der Folgenden sein: `member`, `maintainer`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List team members (Legacy)“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found

Codebeispiele für „List team members (Legacy)“

Anforderungsbeispiel

get/teams/{team_id}/members

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/members

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Get team member (Legacy)

The "Get team member" endpoint (described below) is closing down.

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.

Differenzierte Zugriffstoken für "Get team member (Legacy)"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Parameter für „Get team member (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Get team member (Legacy)“

Statuscode	BESCHREIBUNG
`204`	if user is a member
`404`	if user is not a member

Codebeispiele für „Get team member (Legacy)“

Anforderungsbeispiel

get/teams/{team_id}/members/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/members/USERNAME

if user is a member

Status: 204

Add team member (Legacy)

The "Add team member" endpoint (described below) is closing down.

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 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 that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

Differenzierte Zugriffstoken für "Add team member (Legacy)"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Add team member (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Add team member (Legacy)“

Statuscode	BESCHREIBUNG
`204`	No Content
`403`	Forbidden
`404`	Not Found if team synchronization is set up
`422`	Unprocessable 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

Codebeispiele für „Add team member (Legacy)“

Anforderungsbeispiel

put/teams/{team_id}/members/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/members/USERNAME

Response

Status: 204

Remove team member (Legacy)

The "Remove team member" endpoint (described below) is closing down.

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 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."

Differenzierte Zugriffstoken für "Remove team member (Legacy)"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Remove team member (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove team member (Legacy)“

Statuscode	BESCHREIBUNG
`204`	No Content
`404`	Not Found if team synchronization is setup

Codebeispiele für „Remove team member (Legacy)“

Anforderungsbeispiel

delete/teams/{team_id}/members/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/members/USERNAME

Response

Status: 204

Get team membership for a user (Legacy)

Warning

Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.

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: 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 Create a team.

Parameter für „Get team membership for a user (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Get team membership for a user (Legacy)“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found

Codebeispiele für „Get team membership for a user (Legacy)“

Anforderungsbeispiel

get/teams/{team_id}/memberships/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/memberships/USERNAME

Response if user is a team maintainer

Status: 200

{
  "url": "https://HOSTNAME/teams/1/memberships/octocat",
  "role": "maintainer",
  "state": "active"
}

Add or update team membership for a user (Legacy)

Warning

Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

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."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user 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. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

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.

Parameter für „Add or update team membership for a user (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.
`username` string Erforderlich The handle for the GitHub user account.

Textparameter
Name, type, BESCHREIBUNG
`role` string The role that this user should have in the team. Standard: `member` Kann eine der Folgenden sein: `member`, `maintainer`

HTTP-Antwortstatuscodes für „Add or update team membership for a user (Legacy)“

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden if team synchronization is set up
`404`	Resource not found
`422`	Unprocessable Entity if you attempt to add an organization to a team

Codebeispiele für „Add or update team membership for a user (Legacy)“

Anforderungsbeispiel

put/teams/{team_id}/memberships/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/memberships/USERNAME \
  -d '{"role":"member"}'

Response if user's membership with team is now pending

Status: 200

{
  "url": "https://HOSTNAME/teams/1/memberships/octocat",
  "role": "member",
  "state": "pending"
}

Remove team membership for a user (Legacy)

Warning

Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

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."

Parameter für „Remove team membership for a user (Legacy)“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`team_id` integer Erforderlich The unique identifier of the team.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove team membership for a user (Legacy)“

Statuscode	BESCHREIBUNG
`204`	No Content
`403`	if team synchronization is set up

Codebeispiele für „Remove team membership for a user (Legacy)“

Anforderungsbeispiel

delete/teams/{team_id}/memberships/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/teams/TEAM_ID/memberships/USERNAME

Response

Status: 204