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

组织角色的 REST API 端点

使用 REST API 与组织角色进行交互。

列出组织的细粒度权限

列出可以在组织的自定义组织角色中使用的细粒度权限。有关更多信息，请参阅 "使用角色管理人员对组织的访问权限."

要列出可以在组织的自定义仓库角色中使用的细粒度权限，请参阅 "列出组织的仓库细粒度权限."

要使用此端点，经过身份验证的用户必须是以下之一

  • 组织的管理员。
  • 具有组织中 read_organization_custom_org_role 细粒度权限的用户或团队中的用户。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

用于“列出组织的细粒度权限”的细粒度访问令牌

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

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

  • "自定义组织角色" 组织权限（读取）

“列出组织的细粒度权限”的参数

标头
accept string

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

路径参数
org string 必需

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

“列出组织的细粒度权限”的 HTTP 响应状态代码

状态代码描述
200

OK

404

资源未找到

422

验证失败，或端点已被垃圾邮件轰炸。

“列出组织的细粒度权限”的代码示例

请求示例

get/orgs/{org}/organization-fine-grained-permissions
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/organization-fine-grained-permissions

响应

状态：200
[ { "name": "read_organization_custom_org_role", "description": "查看组织角色" }, { "name": "write_organization_custom_org_role", "description": "管理自定义组织角色" } ]

获取组织的所有组织角色

列出此组织中可用的组织角色。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，经过身份验证的用户必须是以下之一

  • 组织的管理员。
  • 具有组织中 read_organization_custom_org_role 细粒度权限的用户或团队中的用户。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“获取组织的所有组织角色”的细粒度访问令牌

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

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

  • "自定义组织角色" 组织权限（读取）

“获取组织的所有组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

“获取组织的所有组织角色”的 HTTP 响应状态代码

状态代码描述
200

响应 - 组织角色列表

404

资源未找到

422

验证失败，或端点已被垃圾邮件轰炸。

“获取组织的所有组织角色”的代码示例

请求示例

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

响应 - 组织角色列表

状态：200
{ "total_count": 2, "roles": [ { "id": 8030, "name": "Custom Role Manager", "description": "Permissions to manage custom roles within an org", "permissions": [ "write_organization_custom_repo_role", "write_organization_custom_org_role", "read_organization_custom_repo_role", "read_organization_custom_org_role" ], "organization": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:20:11Z" }, { "id": 8031, "name": "Auditor", "description": "Permissions to read the organization audit log", "permissions": [ "read_audit_logs" ], "organization": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:20:11Z" } ] }

创建自定义组织角色

创建自定义组织角色，可以将其分配给用户和团队，授予他们对组织的特定权限。有关自定义组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，经过身份验证的用户必须是以下之一

  • 组织的管理员。
  • 具有组织中write_organization_custom_org_role细粒度权限的用户或团队中的用户。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

用于“创建自定义组织角色”的细粒度访问令牌

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

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

  • “自定义组织角色”组织权限（写入）

“创建自定义组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

主体参数
name 字符串 必需

自定义角色的名称。

description 字符串

关于此角色的预期用途或其授予的权限的简短描述。

permissions 字符串数组 必需

此角色中包含的附加权限列表。

“创建自定义组织角色”的 HTTP 响应状态代码

状态代码描述
201

已创建

404

资源未找到

409

冲突

422

验证失败，或端点已被垃圾邮件轰炸。

“创建自定义组织角色”的代码示例

请求示例

post/orgs/{org}/organization-roles
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/organization-roles \ -d '{"name":"Custom Role Manager","description":"Permissions to manage custom roles within an org","permissions":["write_organization_custom_repo_role","write_organization_custom_org_role","read_organization_custom_repo_role","read_organization_custom_org_role"]}'

响应

状态：201
{ "id": 8030, "name": "Custom Role Manager", "description": "Permissions to manage custom roles within an org", "permissions": [ "write_organization_custom_repo_role", "write_organization_custom_org_role", "read_organization_custom_repo_role", "read_organization_custom_org_role" ], "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" }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:19:11Z" }

删除团队的所有组织角色

从团队中删除所有分配的组织角色。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

使用此端点，经过身份验证的用户必须是该组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“删除团队的所有组织角色”的细粒度访问令牌

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

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

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

“删除团队的所有组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

team_slug 字符串 必需

团队名称的标识符。

“删除团队的所有组织角色”的 HTTP 响应状态代码

状态代码描述
204

无内容

“删除团队的所有组织角色”的代码示例

请求示例

delete/orgs/{org}/organization-roles/teams/{team_slug}
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/organization-roles/teams/TEAM_SLUG

响应

状态：204

将组织角色分配给团队

将组织角色分配给组织中的团队。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

使用此端点，经过身份验证的用户必须是该组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“将组织角色分配给团队”的细粒度访问令牌

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

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

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

“将组织角色分配给团队”的参数

标头
accept string

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

路径参数
org string 必需

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

team_slug 字符串 必需

团队名称的标识符。

role_id 整数 必需

角色的唯一标识符。

“将组织角色分配给团队”的 HTTP 响应状态代码

状态代码描述
204

无内容

404

如果组织、团队或角色不存在，则返回响应。

422

如果组织未启用组织角色功能或验证失败，则返回响应。

“将组织角色分配给团队”的代码示例

请求示例

put/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}
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/organization-roles/teams/TEAM_SLUG/ROLE_ID

响应

状态：204

从团队中删除组织角色

从团队中删除组织角色。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

使用此端点，经过身份验证的用户必须是该组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“从团队中删除组织角色”的细粒度访问令牌

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

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

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

“从团队中删除组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

team_slug 字符串 必需

团队名称的标识符。

role_id 整数 必需

角色的唯一标识符。

从团队中删除组织角色的 HTTP 响应状态码

状态代码描述
204

无内容

从团队中删除组织角色的代码示例

请求示例

delete/orgs/{org}/organization-roles/teams/{team_slug}/{role_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/organization-roles/teams/TEAM_SLUG/ROLE_ID

响应

状态：204

删除用户的所有组织角色

撤销分配给用户的全部组织角色。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

使用此端点，经过身份验证的用户必须是该组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

用于“删除用户的所有组织角色”的细粒度访问令牌

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

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

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

用于“删除用户的所有组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

username string 必需

GitHub 用户帐户的句柄。

用于“删除用户的所有组织角色”的 HTTP 响应状态码

状态代码描述
204

无内容

用于“删除用户的所有组织角色”的代码示例

请求示例

delete/orgs/{org}/organization-roles/users/{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/organization-roles/users/USERNAME

响应

状态：204

将组织角色分配给用户

将组织角色分配给组织成员。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

使用此端点，经过身份验证的用户必须是该组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

用于“将组织角色分配给用户”的细粒度访问令牌

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

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

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

用于“将组织角色分配给用户”的参数

标头
accept string

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

路径参数
org string 必需

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

username string 必需

GitHub 用户帐户的句柄。

role_id 整数 必需

角色的唯一标识符。

用于“将组织角色分配给用户”的 HTTP 响应状态码

状态代码描述
204

无内容

404

如果组织、用户或角色不存在，则返回响应。

422

如果组织角色功能未为组织启用，验证失败或用户不是组织成员，则返回响应。

用于“将组织角色分配给用户”的代码示例

请求示例

put/orgs/{org}/organization-roles/users/{username}/{role_id}
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/organization-roles/users/USERNAME/ROLE_ID

响应

状态：204

从用户中删除组织角色

从用户中移除组织角色。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

使用此端点，经过身份验证的用户必须是该组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“从用户中移除组织角色”的细粒度访问令牌

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

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

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

“从用户中移除组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

username string 必需

GitHub 用户帐户的句柄。

role_id 整数 必需

角色的唯一标识符。

“从用户中移除组织角色”的 HTTP 响应状态代码

状态代码描述
204

无内容

“从用户中移除组织角色”的代码示例

请求示例

delete/orgs/{org}/organization-roles/users/{username}/{role_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/organization-roles/users/USERNAME/ROLE_ID

响应

状态：204

获取组织角色

获取此组织可用的组织角色。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，经过身份验证的用户必须是以下之一

  • 组织的管理员。
  • 具有组织中 read_organization_custom_org_role 细粒度权限的用户或团队中的用户。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“获取组织角色”的细粒度访问令牌

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

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

  • "自定义组织角色" 组织权限（读取）

“获取组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

role_id 整数 必需

角色的唯一标识符。

“获取组织角色”的 HTTP 响应状态代码

状态代码描述
200

OK

404

资源未找到

422

验证失败，或端点已被垃圾邮件轰炸。

“获取组织角色”的代码示例

请求示例

get/orgs/{org}/organization-roles/{role_id}
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/organization-roles/ROLE_ID

响应

状态：200
{ "id": 8030, "name": "Custom Role Manager", "description": "Permissions to manage custom roles within an org", "permissions": [ "write_organization_custom_repo_role", "write_organization_custom_org_role", "read_organization_custom_repo_role", "read_organization_custom_org_role" ], "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" }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:20:11Z" }

更新自定义组织角色

更新现有的自定义组织角色。权限更改将应用于所有被分配者。有关自定义组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，经过身份验证的用户必须是以下之一

  • 组织的管理员。
  • 具有组织中write_organization_custom_org_role细粒度权限的用户或团队中的用户。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“更新自定义组织角色”的细粒度访问令牌

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

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

  • “自定义组织角色”组织权限（写入）

“更新自定义组织角色”的参数

标头
accept string

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

路径参数
org string 必需

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

role_id 整数 必需

角色的唯一标识符。

主体参数
name 字符串

自定义角色的名称。

description 字符串

关于此角色的预期用途或其授予的权限的简短描述。

permissions 字符串数组

此角色中包含的附加权限列表。

“更新自定义组织角色”的 HTTP 响应状态码

状态代码描述
200

OK

404

资源未找到

409

冲突

422

验证失败，或端点已被垃圾邮件轰炸。

“更新自定义组织角色”的代码示例

请求示例

patch/orgs/{org}/organization-roles/{role_id}
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/orgs/ORG/organization-roles/ROLE_ID \ -d '{"description":"Permissions to manage custom roles within an org."}'

响应

状态：200
{ "id": 8030, "name": "Custom Role Manager", "description": "Permissions to manage custom roles within an org", "permissions": [ "write_organization_custom_repo_role", "write_organization_custom_org_role", "read_organization_custom_repo_role", "read_organization_custom_org_role" ], "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" }, "created_at": "2022-07-04T22:19:11Z", "updated_at": "2022-07-04T22:19:11Z" }

删除自定义组织角色。

删除自定义组织角色。有关自定义组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，经过身份验证的用户必须是以下之一

  • 组织的管理员。
  • 具有组织中write_organization_custom_org_role细粒度权限的用户或团队中的用户。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“删除自定义组织角色”的细粒度访问令牌。

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

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

  • “自定义组织角色”组织权限（写入）

“删除自定义组织角色”的参数。

标头
accept string

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

路径参数
org string 必需

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

role_id 整数 必需

角色的唯一标识符。

“删除自定义组织角色”的 HTTP 响应状态码。

状态代码描述
204

无内容

“删除自定义组织角色”的代码示例。

请求示例

delete/orgs/{org}/organization-roles/{role_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/organization-roles/ROLE_ID

响应

状态：204

列出分配给组织角色的团队

列出分配给组织角色的团队。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，您必须是组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“列出分配给组织角色的团队”的细粒度访问令牌

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

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

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

“列出分配给组织角色的团队”的参数

标头
accept string

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

路径参数
org string 必需

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

role_id 整数 必需

角色的唯一标识符。

查询参数
per_page 整数

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

默认: 30

page 整数

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

默认: 1

“列出分配给组织角色的团队”的 HTTP 响应状态代码

状态代码描述
200

响应 - 已分配团队的列表

404

如果组织或角色不存在，则返回响应。

422

如果组织角色功能未启用或验证失败，则返回响应。

“列出分配给组织角色的团队”的代码示例

请求示例

get/orgs/{org}/organization-roles/{role_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/organization-roles/ROLE_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 } ]

列出分配给组织角色的用户

列出分配给组织角色的组织成员。有关组织角色的更多信息，请参阅“使用角色管理人员对组织的访问权限”。

要使用此端点，您必须是组织的管理员。

OAuth 应用令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。

“列出分配给组织角色的用户”的细粒度访问令牌

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

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

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

“列出分配给组织角色的用户”的参数

标头
accept string

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

路径参数
org string 必需

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

role_id 整数 必需

角色的唯一标识符。

查询参数
per_page 整数

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

默认: 30

page 整数

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

默认: 1

“列出分配给组织角色的用户”的 HTTP 响应状态代码

状态代码描述
200

响应 - 已分配用户的列表

404

如果组织或角色不存在，则返回响应。

422

如果组织角色功能未启用或验证失败，则返回响应。

“列出分配给组织角色的用户”的代码示例

请求示例

get/orgs/{org}/organization-roles/{role_id}/users
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/organization-roles/ROLE_ID/users

响应 - 已分配用户的列表

状态：200
[ { "登录名": "octocat", "id": 1, "节点 ID": "MDQ6VXNlcjE=", "头像 URL": "https://github.com/images/error/octocat_happy.gif", "Gravatar ID": "", "URL": "https://api.github.com/users/octocat", "HTML URL": "https://github.com/octocat", "关注者 URL": "https://api.github.com/users/octocat/followers", "关注 URL": "https://api.github.com/users/octocat/following{/other_user}", "Gists URL": "https://api.github.com/users/octocat/gists{/gist_id}", "加星 URL": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "订阅 URL": "https://api.github.com/users/octocat/subscriptions", "组织 URL": "https://api.github.com/users/octocat/orgs", "仓库 URL": "https://api.github.com/users/octocat/repos", "事件 URL": "https://api.github.com/users/octocat/events{/privacy}", "接收事件 URL": "https://api.github.com/users/octocat/received_events", "类型": "用户", "站点管理员": false } ]