REST API теперь версия. Дополнительные сведения см. в разделе "О управлении версиями API".

REST API endpoints for enterprise team memberships

Use the REST API to create and manage membership of enterprise teams in your GitHub enterprise.

About enterprise team members

Примечание.

These endpoints are currently in public preview and subject to change.

This API documentation is for enterprises on GitHub Enterprise Cloud.

If your enterprise is Copilot Business for non-GHE, please refer to the early access documentation link that was previously shared to you.

These endpoints are only available to authenticated members of the enterprise team's enterprise with classic personal access tokens with the read:enterprise scope for GET APIs and admin:enterprise for other APIs.

These endpoints are not compatible with fine-grained personal access tokens or GitHub App access tokens.

GitHub generates the enterprise team's slug from the team name and adds the ent: prefix.

List members in an enterprise team

Lists all team members in an enterprise team.

Подробные маркеры доступа для "List members in an enterprise team

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "List members in an enterprise team"

Заголовки
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
enterprise string Обязательное поле

The slug version of the enterprise name.

enterprise-team string Обязательное поле

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

Параметры запроса
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

По умолчанию.: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

По умолчанию.: 1

Коды состояния http-ответа для "List members in an enterprise team"

Код состоянияОписание
200

OK

Примеры кода для "List members in an enterprise team"

Пример запроса

get/enterprises/{enterprise}/teams/{enterprise-team}/memberships
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships

Response

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

Bulk add team members

Add multiple team members to an enterprise team.

Подробные маркеры доступа для "Bulk add team members

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Bulk add team members"

Заголовки
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
enterprise string Обязательное поле

The slug version of the enterprise name.

enterprise-team string Обязательное поле

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

Параметры запроса
usernames array of strings Обязательное поле

The GitHub user handles to add to the team.

Коды состояния http-ответа для "Bulk add team members"

Код состоянияОписание
200

Successfully added team members.

Примеры кода для "Bulk add team members"

Пример запроса

post/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/add \ -d '{"usernames":["monalisa","octocat"]}'

Successfully added team members.

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

Bulk remove team members

Remove multiple team members from an enterprise team.

Подробные маркеры доступа для "Bulk remove team members

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Bulk remove team members"

Заголовки
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
enterprise string Обязательное поле

The slug version of the enterprise name.

enterprise-team string Обязательное поле

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

Параметры запроса
usernames array of strings Обязательное поле

The GitHub user handles to be removed from the team.

Коды состояния http-ответа для "Bulk remove team members"

Код состоянияОписание
200

Successfully removed team members.

Примеры кода для "Bulk remove team members"

Пример запроса

post/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/remove \ -d '{"usernames":["monalisa","octocat"]}'

Successfully removed team members.

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

Get enterprise team membership

Returns whether the user is a member of the enterprise team.

Подробные маркеры доступа для "Get enterprise team membership

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Get enterprise team membership"

Заголовки
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
enterprise string Обязательное поле

The slug version of the enterprise name.

enterprise-team string Обязательное поле

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

username string Обязательное поле

The handle for the GitHub user account.

Коды состояния http-ответа для "Get enterprise team membership"

Код состоянияОписание
200

User is a member of the enterprise team.

Примеры кода для "Get enterprise team membership"

Пример запроса

get/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

User is a member of the enterprise team.

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

Add team member

Add a team member to an enterprise team.

Подробные маркеры доступа для "Add team member

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Add team member"

Заголовки
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
enterprise string Обязательное поле

The slug version of the enterprise name.

enterprise-team string Обязательное поле

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

username string Обязательное поле

The handle for the GitHub user account.

Коды состояния http-ответа для "Add team member"

Код состоянияОписание
201

Successfully added team member

Примеры кода для "Add team member"

Пример запроса

put/enterprises/{enterprise}/teams/{enterprise-team}/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" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

Successfully added team member

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

Remove team membership

Remove membership of a specific user from a particular team in an enterprise.

Подробные маркеры доступа для "Remove team membership

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Remove team membership"

Заголовки
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
enterprise string Обязательное поле

The slug version of the enterprise name.

enterprise-team string Обязательное поле

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

username string Обязательное поле

The handle for the GitHub user account.

Коды состояния http-ответа для "Remove team membership"

Код состоянияОписание
204

No Content

403

Forbidden

Примеры кода для "Remove team membership"

Пример запроса

delete/enterprises/{enterprise}/teams/{enterprise-team}/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" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

Response

Status: 204