REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制."

组织成员的 REST API 端点

使用 REST API 管理组织中的成员资格。

列出失败的组织邀请

返回的哈希包含 failed_at 和 failed_reason 字段，分别表示邀请失败的时间和失败的原因。

用于“列出失败的组织邀请”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

“列出失败的组织邀请”的参数

标头
accept string

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

路径参数
org string 必需

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

查询参数
per_page integer

每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页."

默认: 30

page integer

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

默认: 1

“列出失败的组织邀请”的 HTTP 响应状态码

状态码描述
200

OK

404

资源未找到

“列出失败的组织邀请”的代码示例

请求示例

get/orgs/{org}/failed_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/failed_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" } ]

列出待处理的组织邀请

返回的哈希包含一个role字段，它指的是组织邀请的角色，并将是以下值之一：direct_member、admin、billing_manager或hiring_manager。如果被邀请者不是 GitHub 成员，则返回哈希中的login字段将为null。

用于“列出待处理的组织邀请”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

“列出待处理的组织邀请”的参数

标头
accept string

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

路径参数
org string 必需

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

查询参数
per_page integer

每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页."

默认: 30

page integer

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

默认: 1

role string

按其成员角色过滤邀请。

默认: all

可以是以下之一: all, admin, direct_member, billing_manager, hiring_manager

invitation_source string

按其邀请来源过滤邀请。

默认: all

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

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

状态码描述
200

OK

404

资源未找到

“列出待处理的组织邀请”的代码示例

请求示例

get/orgs/{org}/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/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" } ]

创建组织邀请

使用 GitHub 用户 ID 或电子邮件地址邀请人员加入组织。为了在组织中创建邀请，经过身份验证的用户必须是组织所有者。

此端点会触发 通知。使用此端点过快地创建内容可能会导致二级速率限制。有关更多信息，请参阅“API 速率限制”和“使用 REST API 的最佳实践”。

用于“创建组织邀请”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（写入）

“创建组织邀请”的参数

标头
accept string

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

路径参数
org string 必需

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

主体参数
invitee_id integer

除非您提供 email，否则为必填项。您要邀请的人的 GitHub 用户 ID。

email string

除非您提供 invitee_id，否则为必填项。您要邀请的人的电子邮件地址，可以是现有的 GitHub 用户。

role string

新成员的角色。

  • admin - 拥有组织的完全管理权限的组织所有者，可以完全访问所有仓库和团队。
  • direct_member - 非所有者组织成员，可以查看其他成员并通过邀请加入团队。
  • billing_manager - 非所有者组织成员，可以管理组织的账单设置。
  • reinstate - 被邀请人从您的组织中移除之前分配给他们的先前角色。可以是上面列出的任何角色之一。仅在被邀请人之前是您组织的一部分时有效。

默认: direct_member

可以是以下之一: admin, direct_member, billing_manager, reinstate

team_ids 整数数组

指定您要邀请新成员加入的团队的 ID。

“创建组织邀请”的 HTTP 响应状态代码

状态码描述
201

已创建

404

资源未找到

422

验证失败，或端点已被滥用。

“创建组织邀请”的代码示例

请求示例

post/orgs/{org}/invitations
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/orgs/ORG/invitations \ -d '{"email":"[email protected]","role":"direct_member","team_ids":[12,26]}'

响应

状态：201
{ "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "[email protected]", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "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 string

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

路径参数
org string 必需

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

invitation_id 整数 必需

邀请的唯一标识符。

“取消组织邀请”的 HTTP 响应状态码

状态码描述
204

无内容

404

资源未找到

422

验证失败，或端点已被滥用。

“取消组织邀请”的代码示例

请求示例

删除/orgs/{org}/invitations/{invitation_id}
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/invitations/INVITATION_ID

响应

状态：204

列出组织邀请团队

列出与邀请关联的所有团队。为了查看组织中的邀请，经过身份验证的用户必须是组织所有者。

针对“列出组织邀请团队”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

“列出组织邀请团队”的参数

标头
accept string

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

路径参数
org string 必需

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

invitation_id 整数 必需

邀请的唯一标识符。

查询参数
per_page integer

每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页."

默认: 30

page integer

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

默认: 1

“列出组织邀请团队”的 HTTP 响应状态码

状态码描述
200

OK

404

资源未找到

“列出组织邀请团队”的代码示例

请求示例

获取/orgs/{org}/invitations/{invitation_id}/teams
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/invitations/INVITATION_ID/teams

响应

状态: 200
[ { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ]

列出组织成员

列出所有组织成员。如果经过身份验证的用户也是该组织的成员，则将返回隐藏和公开成员。

针对“列出组织成员”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

如果仅请求公共资源，则可以在没有身份验证或上述权限的情况下使用此端点。

“列出组织成员”的参数

标头
accept string

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

路径参数
org string 必需

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

查询参数
filter 字符串

筛选返回列表中的成员。2fa_disabled 表示仅返回未启用双重身份验证的成员。此选项仅对组织所有者可用。

默认: all

可以是以下之一: 2fa_disabled, all

role string

根据角色筛选返回的成员。

默认: all

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

per_page integer

每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页."

默认: 30

page integer

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

默认: 1

“列出组织成员”的 HTTP 响应状态代码

状态码描述
200

OK

422

验证失败，或端点已被滥用。

“列出组织成员”的代码示例

请求示例

get/orgs/{org}/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/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 string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

“检查用户是否属于组织成员”的 HTTP 响应状态代码

状态码描述
204

如果请求者是组织成员且用户是成员，则返回响应

302

如果请求者不是组织成员，则返回响应

404

如果请求者是组织成员且用户不是成员，则返回“未找到”

检查用户组织成员资格的代码示例

请求示例

获取/orgs/{org}/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/orgs/ORG/members/USERNAME

如果请求者是组织成员且用户是成员，则返回响应

状态：204

删除组织成员

从该列表中删除用户将从所有团队中删除他们，并且他们将不再拥有对组织存储库的任何访问权限。

用于“删除组织成员”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（写入）

用于“删除组织成员”的参数

标头
accept string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

用于“删除组织成员”的 HTTP 响应状态代码

状态码描述
204

无内容

403

禁止

用于“删除组织成员”的代码示例

请求示例

删除/orgs/{org}/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/orgs/ORG/members/USERNAME

响应

状态：204

获取用户组织成员资格

为了获取用户对组织的成员资格，经过身份验证的用户必须是组织成员。响应中的 state 参数可用于识别用户的成员资格状态。

用于“获取用户组织成员资格”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

用于“获取用户组织成员资格”的参数

标头
accept string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

用于“获取用户组织成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

403

禁止

404

资源未找到

用于“获取用户组织成员资格”的代码示例

请求示例

获取/orgs/{org}/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/memberships/USERNAME

如果用户拥有组织的活动管理员成员资格，则响应

状态: 200
{ "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "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 } }

设置用户组织成员资格

只有经过身份验证的组织所有者才能将成员添加到组织或更新成员的角色。

  • 如果经过身份验证的用户正在添加组织成员，则受邀用户将收到一封电子邮件，邀请他们加入组织。用户的成员资格状态将为pending，直到他们接受邀请。

  • 经过身份验证的用户可以通过传递role参数来更新用户的成员资格。如果经过身份验证的用户将成员的角色更改为admin，则受影响的用户将收到一封电子邮件，通知他们已成为组织所有者。如果经过身份验证的用户将所有者的角色更改为member，则不会发送任何电子邮件。

速率限制

为了防止滥用，组织所有者在 24 小时内为组织创建的组织邀请数量限制为 50 个。如果组织的创建日期超过一个月或处于付费计划中，则每 24 小时内的邀请数量限制为 500 个。

用于“设置用户组织成员资格”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（写入）

用于“设置用户组织成员资格”的参数

标头
accept string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

主体参数
role string

要赋予用户在组织中的角色。可以是以下之一

  • admin - 用户将成为组织的所有者。
  • member - 用户将成为组织的非所有者成员。

默认: member

可以是以下之一: admin, member

用于“设置用户组织成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

403

禁止

422

验证失败，或端点已被滥用。

用于“设置用户组织成员资格”的代码示例

请求示例

put/orgs/{org}/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/memberships/USERNAME \ -d '{"role":"member"}'

如果用户拥有组织的活动管理员成员资格，则响应

状态: 200
{ "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "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 string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

用于“删除用户组织成员资格”的 HTTP 响应状态代码

状态码描述
204

无内容

403

禁止

404

资源未找到

用于“删除用户组织成员资格”的代码示例

请求示例

delete/orgs/{org}/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/memberships/USERNAME

响应

状态：204

列出公共组织成员

组织成员可以选择公开或不公开其成员资格。

用于“列出公共组织成员”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

如果仅请求公共资源，则可以在没有身份验证或上述权限的情况下使用此端点。

用于“列出公共组织成员”的参数

标头
accept string

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

路径参数
org string 必需

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

查询参数
per_page integer

每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页."

默认: 30

page integer

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

默认: 1

用于“列出公共组织成员”的 HTTP 响应状态代码

状态码描述
200

OK

用于“列出公共组织成员”的代码示例

请求示例

get/orgs/{org}/public_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/public_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 string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

用于“检查用户的公共组织成员资格”的 HTTP 响应状态代码

状态码描述
204

如果用户是公共成员，则返回响应

404

如果用户不是公共成员，则返回“未找到”

用于“检查用户的公共组织成员资格”的代码示例

请求示例

get/orgs/{org}/public_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/orgs/ORG/public_members/USERNAME

如果用户是公共成员，则返回响应

状态：204

设置认证用户的公开组织成员资格

用户可以公开自己的成员资格。（用户无法公开其他用户的成员资格。）

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

“设置认证用户的公开组织成员资格”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（写入）

“设置认证用户的公开组织成员资格”的参数

标头
accept string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

“设置认证用户的公开组织成员资格”的 HTTP 响应状态代码

状态码描述
204

无内容

403

禁止

“设置认证用户的公开组织成员资格”的代码示例

请求示例

put/orgs/{org}/public_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/orgs/ORG/public_members/USERNAME

响应

状态：204

删除认证用户的公开组织成员资格

删除认证用户在指定组织中的公开成员资格，除非默认情况下强制执行公开可见性。

“删除认证用户的公开组织成员资格”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（写入）

“删除认证用户的公开组织成员资格”的参数

标头
accept string

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

路径参数
org string 必需

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

username 字符串 必需

GitHub 用户帐户的句柄。

“删除认证用户的公开组织成员资格”的 HTTP 响应状态代码

状态码描述
204

无内容

“删除认证用户的公开组织成员资格”的代码示例

请求示例

delete/orgs/{org}/public_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/orgs/ORG/public_members/USERNAME

响应

状态：204

列出认证用户的组织成员资格

列出认证用户的所有组织成员资格。

“列出认证用户的组织成员资格”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

细粒度令牌不需要任何权限。

“列出认证用户的组织成员资格”的参数

标头
accept string

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

查询参数
state string

指示要返回的成员资格状态。如果未指定，API 将返回活动和待处理的成员资格。

可以是以下之一： active, pending

per_page integer

每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页."

默认: 30

page integer

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

默认: 1

“列出经过身份验证的用户的组织成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

422

验证失败，或端点已被滥用。

“列出经过身份验证的用户的组织成员资格”的代码示例

请求示例

get/user/memberships/orgs
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/user/memberships/orgs

响应

状态: 200
[ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "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 } }, { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", "role": "admin", "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "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 } } ]

获取经过身份验证的用户的组织成员资格

如果经过身份验证的用户是组织的活动成员或待处理成员，则此端点将返回用户的成员资格。如果经过身份验证的用户与组织无关，则返回 404。如果请求由组织阻止的 GitHub 应用程序发出，则此端点将返回 403。

“获取经过身份验证的用户的组织成员资格”的细粒度访问令牌

此端点与以下细粒度令牌类型配合使用

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

  • “成员”组织权限（读取）

“获取经过身份验证的用户的组织成员资格”的参数

标头
accept string

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

路径参数
org string 必需

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

“获取经过身份验证的用户的组织成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

403

禁止

404

资源未找到

“获取经过身份验证的用户的组织成员资格”的代码示例

请求示例

get/user/memberships/orgs/{org}
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/user/memberships/orgs/ORG

响应

状态: 200
{ "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", "role": "admin", "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "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 string

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

路径参数
org string 必需

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

主体参数
state string 必需

成员资格应处的状态。仅接受"active"。

值: active

“更新已认证用户的组织成员资格”的 HTTP 响应状态代码

状态码描述
200

OK

403

禁止

404

资源未找到

422

验证失败，或端点已被滥用。

“更新已认证用户的组织成员资格”的代码示例

请求示例

patch/user/memberships/orgs/{org}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/memberships/orgs/ORG \ -d '{"state":"active"}'

响应

状态: 200
{ "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "user": { "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 } }