跳至主要内容
REST API 现在已版本化。 有关更多信息,请参阅“关于 API 版本控制”。

团队成员的 REST API 端点

使用 REST API 创建和管理 GitHub 组织中的团队成员资格。

关于团队成员

这些端点仅对团队的 组织 的已认证成员可用。OAuth 访问令牌需要 read:org 范围。GitHub 从团队 name 生成团队的 slug

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,将会看到错误。如果您有权管理 IdP 中的组成员资格,则可以通过标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“管理组织的团队同步”。

列出待处理的团队邀请

返回的哈希包含一个 role 字段,该字段指的是组织邀请角色,并将是以下值之一:direct_memberadminbilling_managerhiring_managerreinstate。如果被邀请者不是 GitHub 成员,则返回的哈希中的 login 字段将为 null

注意:您还可以使用路由 GET /organizations/{org_id}/team/{team_id}/invitations 通过 org_idteam_id 指定团队。

"列出待处理的团队邀请" 的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
org 字符串 必填

组织名称。名称不区分大小写。

team_slug 字符串 必填

团队名称的标识。

查询参数
名称,类型,描述
per_page 整数

每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 30

page 整数

要获取的结果页码。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 1

“列出待处理的团队邀请”的 HTTP 响应状态码

状态码描述
200

OK

“列出待处理的团队邀请”的代码示例

请求示例

get/orgs/{org}/teams/{team_slug}/invitations
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/orgs/ORG/teams/TEAM_SLUG/invitations

响应

状态:200
[ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "[email protected]", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", "invitation_source": "member" } ]

列出团队成员

团队成员将包括子团队的成员。

要列出团队中的成员,团队必须对经过身份验证的用户可见。

"列出团队成员"的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
org 字符串 必填

组织名称。名称不区分大小写。

team_slug 字符串 必填

团队名称的标识。

查询参数
名称,类型,描述
role string

根据成员在团队中的角色过滤返回的成员。

默认: all

可以是以下之一: member, maintainer, all

per_page 整数

每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 30

page 整数

要获取的结果页码。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 1

"列出团队成员"的 HTTP 响应状态码

状态码描述
200

OK

"列出团队成员"的代码示例

请求示例

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" \ https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members

响应

状态: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 /organizations/{org_id}/team/{team_id}/memberships/{username}通过org_idteam_id指定团队。

注意:响应包含成员资格的state和成员的role

组织所有者的role设置为maintainer。有关maintainer角色的更多信息,请参阅创建团队

“获取用户团队成员资格”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
org 字符串 必填

组织名称。名称不区分大小写。

team_slug 字符串 必填

团队名称的标识。

username string 必需

GitHub 用户帐户的句柄。

“获取用户团队成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

404

如果用户没有团队成员资格

“获取用户团队成员资格”的代码示例

请求示例

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" \ https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

如果用户是团队维护者,则响应

状态:200
{ "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", "state": "active" }

添加或更新用户团队成员资格

将组织成员添加到团队。已认证的组织所有者或团队维护者可以将组织成员添加到团队。

团队同步适用于使用 GitHub Enterprise Cloud 的组织。有关更多信息,请参阅 GitHub 帮助文档中的GitHub 产品

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,您将看到错误。如果您有权管理 IdP 中的组成员资格,您可以通过您的标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“在您的标识提供者和 GitHub 之间同步团队”。

组织所有者可以将不在团队组织中的人添加到团队。当组织所有者将不在组织中的某人添加到团队时,此端点将通过电子邮件向该人发送邀请。此新创建的成员资格将处于“待处理”状态,直到该人接受邀请,此时成员资格将转换为“活动”状态,并且该用户将被添加为团队成员。

如果用户已经是团队成员,则此端点将更新团队成员的角色。要更新团队成员的成员资格,经过身份验证的用户必须是组织所有者或团队维护者。

注意:您也可以使用路线PUT /organizations/{org_id}/team/{team_id}/memberships/{username}通过org_idteam_id指定团队。

“添加或更新用户团队成员资格”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
org 字符串 必填

组织名称。名称不区分大小写。

team_slug 字符串 必填

团队名称的标识。

username string 必需

GitHub 用户帐户的句柄。

主体参数
名称,类型,描述
role string

此用户在团队中应具有的角色。

默认: member

可以是以下之一: member, maintainer

“添加或更新用户团队成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

403

如果设置了团队同步,则禁止

422

如果您尝试将组织添加到团队,则不可处理的实体

“添加或更新用户团队成员资格”的代码示例

请求示例

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" \ https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \ -d '{"role":"maintainer"}'

如果用户与团队的成员资格现在处于待处理状态,则响应

状态:200
{ "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", "state": "pending" }

删除用户团队成员资格

要删除用户与团队之间的成员资格,经过身份验证的用户必须对团队具有“admin”权限,或者是对团队所属组织的所有者。删除团队成员资格不会删除用户,它只是从团队中删除了他们的成员资格。

团队同步适用于使用 GitHub Enterprise Cloud 的组织。有关更多信息,请参阅 GitHub 帮助文档中的GitHub 产品

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,您将看到错误。如果您有权管理 IdP 中的组成员资格,您可以通过您的标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“在您的标识提供者和 GitHub 之间同步团队”。

注意:您也可以使用路线DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}通过org_idteam_id指定团队。

“删除用户团队成员资格”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
org 字符串 必填

组织名称。名称不区分大小写。

team_slug 字符串 必填

团队名称的标识。

username string 必需

GitHub 用户帐户的句柄。

“删除用户团队成员资格”的 HTTP 响应状态代码

状态码描述
204

无内容

403

如果设置了团队同步,则禁止

“删除用户团队成员资格”的代码示例

请求示例

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" \ https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME

响应

状态: 204

列出待处理的团队邀请(旧版)

弃用通知:此端点路由已弃用,并将从团队 API 中删除。我们建议您将现有代码迁移到新的 列出待处理的团队邀请 端点。

返回的哈希包含一个 role 字段,该字段指的是组织邀请角色,并将是以下值之一:direct_memberadminbilling_managerhiring_managerreinstate。如果被邀请者不是 GitHub 成员,则返回的哈希中的 login 字段将为 null

“列出待处理的团队邀请(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

查询参数
名称,类型,描述
per_page 整数

每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 30

page 整数

要获取的结果页码。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 1

“列出待处理的团队邀请(旧版)”的 HTTP 响应状态码

状态码描述
200

OK

“列出待处理的团队邀请(旧版)”的代码示例

请求示例

get/teams/{team_id}/invitations
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/teams/TEAM_ID/invitations

响应

状态:200
[ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "[email protected]", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", "invitation_source": "member" } ]

列出团队成员(旧版)

弃用通知:此端点路由已弃用,并将从团队 API 中删除。我们建议您将现有代码迁移到新的 列出团队成员 端点。

团队成员将包括子团队的成员。

“列出团队成员(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

查询参数
名称,类型,描述
role string

根据成员在团队中的角色过滤返回的成员。

默认: all

可以是以下之一: member, maintainer, all

per_page 整数

每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 30

page 整数

要获取的结果页码。有关更多信息,请参阅“在 REST API 中使用分页”。

默认: 1

“列出团队成员(旧版)”的 HTTP 响应状态码

状态码描述
200

OK

404

资源未找到

“列出团队成员(旧版)”的代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/members

响应

状态: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 } ]

获取团队成员(旧版)

“获取团队成员”端点(如下所述)已弃用。

我们建议您使用 获取用户团队成员资格 端点。它允许您获取活动成员资格和待处理成员资格。

要列出团队中的成员,团队必须对经过身份验证的用户可见。

“获取团队成员(旧版)”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “成员”组织权限(读取)

“获取团队成员(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

username string 必需

GitHub 用户帐户的句柄。

“获取团队成员(旧版)”的 HTTP 响应状态码

状态码描述
204

如果用户是成员

404

如果用户不是成员

“获取团队成员(旧版)”的代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/members/USERNAME

如果用户是成员

状态: 204

添加团队成员(旧版)

“添加团队成员”端点(如下所述)已弃用。

我们建议使用 为用户添加或更新团队成员资格 端点。它允许您邀请新的组织成员加入您的团队。

团队同步适用于使用 GitHub Enterprise Cloud 的组织。有关更多信息,请参阅 GitHub 帮助文档中的GitHub 产品

要将某人添加到团队,经过身份验证的用户必须是组织所有者或他们正在更改的团队的团队维护者。被添加到团队的人必须是团队所属组织的成员。

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,您将看到错误。如果您有权管理 IdP 中的组成员资格,您可以通过您的标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“在您的标识提供者和 GitHub 之间同步团队”。

请注意,在调用此端点时,您需要将 Content-Length 设置为零。有关更多信息,请参阅“HTTP 方法”。

“添加团队成员(旧版)”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “成员”组织权限(写入)

“添加团队成员(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

username string 必需

GitHub 用户帐户的句柄。

“添加团队成员(旧版)”的 HTTP 响应状态码

状态码描述
204

无内容

403

禁止

404

如果设置了团队同步,则找不到

422

如果尝试将组织添加到团队,或者尝试在用户不是同一组织中至少一个其他团队的成员时将用户添加到团队,则无法处理的实体

“添加团队成员(旧版)”的代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/members/USERNAME

响应

状态: 204

删除团队成员(旧版)

“删除团队成员”端点(如下所述)已弃用。

我们建议使用 删除用户的团队成员资格 端点。它允许您删除活动成员资格和待处理成员资格。

团队同步适用于使用 GitHub Enterprise Cloud 的组织。有关更多信息,请参阅 GitHub 帮助文档中的GitHub 产品

要删除团队成员,经过身份验证的用户必须对团队具有“管理员”权限,或者是对团队所属组织的所有者。删除团队成员不会删除用户,只会将其从团队中删除。

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,您将看到错误。如果您有权管理 IdP 中的组成员资格,您可以通过您的标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“在您的标识提供者和 GitHub 之间同步团队”。

“删除团队成员(旧版)”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “成员”组织权限(写入)

“删除团队成员(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

username string 必需

GitHub 用户帐户的句柄。

“删除团队成员(旧版)”的 HTTP 响应状态码

状态码描述
204

无内容

404

如果设置了团队同步,则找不到

“删除团队成员(旧版)”代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/members/USERNAME

响应

状态: 204

获取用户团队成员资格(旧版)

弃用通知:此端点路由已弃用,并将从团队 API 中删除。我们建议您将现有代码迁移到新的 获取用户团队成员资格 端点。

团队成员将包括子团队的成员。

要获取用户在团队中的成员资格,该团队必须对已认证的用户可见。

注意:响应包含成员资格的state和成员的role

组织所有者的role设置为maintainer。有关maintainer角色的更多信息,请参阅创建团队

“获取用户团队成员资格(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

username string 必需

GitHub 用户帐户的句柄。

“获取用户团队成员资格(旧版)”的 HTTP 响应状态代码

状态码描述
200

OK

404

资源未找到

“获取用户团队成员资格(旧版)”代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/memberships/USERNAME

如果用户是团队维护者,则响应

状态:200
{ "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", "state": "active" }

添加或更新用户团队成员资格(旧版)

弃用通知:此端点路由已弃用,并将从团队 API 中删除。我们建议您将现有代码迁移到新的 添加或更新用户团队成员资格 端点。

团队同步适用于使用 GitHub Enterprise Cloud 的组织。有关更多信息,请参阅 GitHub 帮助文档中的GitHub 产品

如果用户已经是团队组织的成员,则此端点将把用户添加到团队中。要添加组织成员和团队之间的成员资格,经过身份验证的用户必须是组织所有者或团队维护者。

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,您将看到错误。如果您有权管理 IdP 中的组成员资格,您可以通过您的标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“在您的标识提供者和 GitHub 之间同步团队”。

如果用户与团队的组织无关,则此端点将通过电子邮件向用户发送邀请。此新创建的成员资格将处于“待处理”状态,直到用户接受邀请,此时成员资格将过渡到“活动”状态,用户将被添加为团队成员。要添加非关联用户和团队之间的成员资格,经过身份验证的用户必须是组织所有者。

如果用户已经是团队成员,则此端点将更新团队成员的角色。要更新团队成员的成员资格,经过身份验证的用户必须是组织所有者或团队维护者。

“添加或更新用户团队成员资格(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

username string 必需

GitHub 用户帐户的句柄。

主体参数
名称,类型,描述
role string

此用户在团队中应具有的角色。

默认: member

可以是以下之一: member, maintainer

“添加或更新用户团队成员资格(旧版)”的 HTTP 响应状态代码

状态码描述
200

OK

403

如果设置了团队同步,则禁止

404

资源未找到

422

如果您尝试将组织添加到团队,则不可处理的实体

“添加或更新用户团队成员资格(旧版)”代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/memberships/USERNAME \ -d '{"role":"member"}'

如果用户与团队的成员资格现在处于待处理状态,则响应

状态:200
{ "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", "state": "pending" }

移除团队成员(旧版)

弃用通知: 此端点路由已弃用,并将从团队 API 中移除。我们建议您将现有代码迁移到新的 移除团队成员 端点。

团队同步适用于使用 GitHub Enterprise Cloud 的组织。有关更多信息,请参阅 GitHub 帮助文档中的GitHub 产品

要删除用户与团队之间的成员资格,经过身份验证的用户必须对团队具有“admin”权限,或者是对团队所属组织的所有者。删除团队成员资格不会删除用户,它只是从团队中删除了他们的成员资格。

注意:当您为组织的标识提供者 (IdP) 设置了团队同步时,如果您尝试使用 API 对团队成员资格进行更改,您将看到错误。如果您有权管理 IdP 中的组成员资格,您可以通过您的标识提供者管理 GitHub 团队成员资格,这会自动在组织中添加和删除团队成员。有关更多信息,请参阅“在您的标识提供者和 GitHub 之间同步团队”。

“移除团队成员(旧版)”的参数

标题
名称,类型,描述
accept 字符串

建议设置为application/vnd.github+json

路径参数
名称,类型,描述
team_id 整数 必需

团队的唯一标识符。

username string 必需

GitHub 用户帐户的句柄。

“移除团队成员(旧版)”的 HTTP 响应状态码

状态码描述
204

无内容

403

如果设置了团队同步

“移除团队成员(旧版)”的代码示例

请求示例

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" \ https://api.github.com/teams/TEAM_ID/memberships/USERNAME

响应

状态: 204