安全管理员的 REST API 端点

关于安全管理员

注意：安全管理员角色处于公开测试阶段，可能会发生变化。

安全管理员是组织级别的角色，组织所有者可以将其分配给组织中的任何团队。应用后，它将授予团队中的每个成员查看安全警报和管理组织代码安全设置的权限，以及读取组织中所有仓库的权限。

列出安全管理员团队

列出组织的安全管理员团队。有关更多信息，请参阅“在组织中管理安全管理员”。

经过身份验证的用户必须是组织的管理员或安全管理员才能使用此端点。

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

用于“列出安全管理员团队”的细粒度访问令牌

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

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

“管理”组织权限（读取）

“列出安全管理员团队”的参数

标头
名称、类型、描述
`accept` string 建议设置为`application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。

“列出安全管理员团队”的 HTTP 响应状态代码

状态代码	描述
`200`	OK

“列出安全管理员团队”的代码示例

请求示例

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": "正义联盟", "slug": "justice-league", "description": "一个很棒的团队。", "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` string 建议设置为`application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`team_slug` 字符串必需团队名称的标识符。

“添加安全管理员团队”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容
`409`	该组织已达到安全管理员团队的最大数量。

“添加安全管理员团队”的代码示例

请求示例

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` string 建议设置为`application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`team_slug` 字符串必需团队名称的标识符。

“删除安全管理员团队”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容

“删除安全管理团队”代码示例

请求示例

删除/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