REST API 现在已版本化。 更多信息,请参阅“关于 API 版本控制”。
安全管理员的 REST API 端点
使用 REST API 管理组织中的安全管理员。
关于安全管理员
注意
安全管理员角色处于公开预览阶段,可能会发生更改。
安全管理员是组织级别的角色,组织所有者可以将其分配给组织中的任何团队。应用后,它使团队的每个成员都具有查看安全警报和管理组织内代码安全的设置的权限,以及对组织中所有代码仓库的读取权限。
列出安全管理员团队
列出作为组织安全管理员的团队。更多信息,请参阅“在您的组织中管理安全管理员”。
经过身份验证的用户必须是组织的管理员或安全管理员才能使用此端点。
OAuth 应用令牌和个人访问令牌(经典版)需要read:org
作用域才能使用此端点。
“列出安全管理员团队”的细粒度访问令牌
此端点可与以下细粒度令牌类型配合使用:
细粒度令牌必须具有以下权限集
- “管理”组织权限(读取)
“列出安全管理员团队”的参数
名称、类型、说明 |
---|
accept 字符串建议设置为 |
名称、类型、说明 |
---|
org 字符串 必需组织名称。名称不区分大小写。 |
“列出安全管理员团队”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | 确定 |
“列出安全管理员团队”的代码示例
请求示例
get/orgs/{org}/security-managers
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/security-managers
响应
状态: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 应用令牌和个人访问令牌(经典版)需要write:org
作用域才能使用此端点。
“添加安全管理员团队”的细粒度访问令牌
此端点可与以下细粒度令牌类型配合使用:
细粒度令牌必须具有以下权限集
- “管理”组织权限(写入)
“添加安全管理员团队”的参数
名称、类型、说明 |
---|
accept 字符串建议设置为 |
名称、类型、说明 |
---|
org 字符串 必需组织名称。名称不区分大小写。 |
team_slug 字符串 必需团队名称的slug。 |
“添加安全管理员团队”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
204 | 无内容 |
“添加安全管理员团队”的代码示例
请求示例
put/orgs/{org}/security-managers/teams/{team_slug}
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/security-managers/teams/TEAM_SLUG
响应
状态:204
移除安全管理员团队
从组织的团队中移除安全管理员角色。更多信息,请参阅“在您的组织中管理安全管理员”。
经过身份验证的用户必须是组织的管理员才能使用此端点。
OAuth 应用令牌和个人访问令牌(经典版)需要admin:org
作用域才能使用此端点。
“移除安全管理员团队”的细粒度访问令牌
此端点可与以下细粒度令牌类型配合使用:
细粒度令牌必须具有以下权限集
- “管理”组织权限(写入)
“移除安全管理员团队”的参数
名称、类型、说明 |
---|
accept 字符串建议设置为 |
名称、类型、说明 |
---|
org 字符串 必需组织名称。名称不区分大小写。 |
team_slug 字符串 必需团队名称的slug。 |
“移除安全管理员团队”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
204 | 无内容 |
“移除安全管理员团队”的代码示例
请求示例
delete/orgs/{org}/security-managers/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/security-managers/teams/TEAM_SLUG
响应
状态:204