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

配置

使用 REST API 创建和管理组织的安全配置。

获取组织的代码安全配置

列出组织中可用的所有代码安全配置。

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

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

“获取组织的代码安全配置”的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

“获取组织的代码安全配置”的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

查询参数
target_type 字符串

代码安全配置的目标类型

默认值： all

可以是以下之一： global, all

per_page 整数

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

默认值： 30

before 字符串

游标，如 链接标头 中所示。如果指定，则查询仅搜索此游标之前的结果。有关更多信息，请参阅“在 REST API 中使用分页”。

after 字符串

游标，如 链接标头 中所示。如果指定，则查询仅搜索此游标之后的结果。有关更多信息，请参阅“在 REST API 中使用分页”。

“获取组织的代码安全配置”的 HTTP 响应状态代码

状态代码描述
200

OK

403

禁止

404

资源未找到

“获取组织的代码安全配置”的代码示例

请求示例

get/orgs/{org}/code-security/configurations
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/code-security/configurations

响应

状态：200
[ { "id": 17, "target_type": "global", "name": "GitHub 推荐", "description": "Dependabot、密钥扫描和代码扫描的建议设置。", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", "secret_scanning_delegated_bypass_options": { "reviewers": [ { "security_configuration_id": 17, "reviewer_id": 5678, "reviewer_type": "TEAM" } ] }, "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" }, { "id": 1326, "target_type": "organization", "name": "高风险设置", "description": "这是 octo-org 高风险代码仓库的代码安全配置", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "enabled", "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", "created_at": "2024-05-10T00:00:00Z", "updated_at": "2024-05-10T00:00:00Z" } ]

创建代码安全配置

在组织中创建一个代码安全配置。

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

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

“创建代码安全配置”的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

“创建代码安全配置”的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

主体参数
name 字符串 必填

代码安全配置的名称。在组织内必须唯一。

description 字符串 必填

代码安全配置的描述

advanced_security 字符串

GitHub 高级安全性的启用状态

默认值： disabled

可以是以下之一： enabled, disabled

dependency_graph 字符串

依赖关系图的启用状态

默认值： enabled

可以是以下之一： enabled, disabled, not_set

dependency_graph_autosubmit_action 字符串

自动依赖项提交的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

dependency_graph_autosubmit_action_options 对象

自动依赖项提交的功能选项

labeled_runners 布尔值

是否使用标记为“dependency-submission”的运行器或标准 GitHub 运行器。

默认值： false

dependabot_alerts 字符串

Dependabot 警报的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

dependabot_security_updates 字符串

Dependabot 安全更新的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

code_scanning_default_setup 字符串

代码扫描默认设置的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

secret_scanning 字符串

密钥扫描的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

secret_scanning_push_protection 字符串

密钥扫描推送保护的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

secret_scanning_delegated_bypass 字符串

密钥扫描委托绕过的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

secret_scanning_delegated_bypass_options 对象

密钥扫描委托绕过的功能选项

reviewers 对象数组

密钥扫描委托绕过的旁路审阅者

reviewer_id 整数 必填

作为旁路审阅者选择的团队或角色的 ID

reviewer_type 字符串 必填

旁路审阅者的类型

可以是以下之一： TEAM, ROLE

secret_scanning_validity_checks 字符串

密钥扫描有效性检查的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

secret_scanning_non_provider_patterns 字符串

密钥扫描非提供程序模式的启用状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

private_vulnerability_reporting 字符串

启用私有漏洞报告的状态

默认值： disabled

可以是以下之一： enabled, disabled, not_set

enforcement 字符串

安全配置的执行状态

默认值: enforced

可以是以下之一: enforced, unenforced

"创建代码安全配置"的HTTP响应状态码

状态代码描述
201

成功创建代码安全配置

"创建代码安全配置"的代码示例

请求示例

post/orgs/{org}/code-security/configurations
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/code-security/configurations \ -d '{"name":"octo-org recommended settings","description":"This is a code security configuration for octo-org","advanced_security":"enabled","dependabot_alerts":"enabled","dependabot_security_updates":"not_set","secret_scanning":"enabled"}'

成功创建代码安全配置

状态: 201
{ "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" }

获取默认代码安全配置

列出组织的默认代码安全配置。

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

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

"获取默认代码安全配置"的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

"获取默认代码安全配置"的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

"获取默认代码安全配置"的HTTP响应状态码

状态代码描述
200

OK

304

未修改

403

禁止

404

资源未找到

"获取默认代码安全配置"的代码示例

请求示例

get/orgs/{org}/code-security/configurations/defaults
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/code-security/configurations/defaults

响应

状态：200
[ { "default_for_new_repos": "public", "configuration": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", "secret_scanning_delegated_bypass_options": { "reviewers": [ { "security_configuration_id": 1325, "reviewer_id": 5678, "reviewer_type": "TEAM" } ] }, "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } }, { "default_for_new_repos": "private_and_internal", "configuration": { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" } } ]

从仓库中分离配置

从一组仓库中分离代码安全配置。仓库将保留其设置，但将不再与配置关联。

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

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

"从仓库中分离配置"的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

"从仓库中分离配置"的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

主体参数
selected_repository_ids 整数数组

要从配置中分离的仓库 ID 数组。

"从仓库中分离配置"的HTTP响应状态码

状态代码描述
204

返回一个没有内容的头部。

400

错误请求

403

禁止

404

资源未找到

409

冲突

"从仓库中分离配置"的代码示例

请求示例

delete/orgs/{org}/code-security/configurations/detach
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/code-security/configurations/detach \ -d '{"selected_repository_ids":[32,91]}'

返回一个没有内容的头部。

状态: 204

获取代码安全配置

获取组织中可用的代码安全配置。

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

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

"获取代码安全配置"的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

"获取代码安全配置"的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

configuration_id 整数 必需

代码安全配置的唯一标识符。

"获取代码安全配置"的HTTP响应状态码

状态代码描述
200

OK

304

未修改

403

禁止

404

资源未找到

"获取代码安全配置"的代码示例

请求示例

get/orgs/{org}/code-security/configurations/{configuration_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/code-security/configurations/CONFIGURATION_ID

响应

状态：200
{ "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" }

更新代码安全配置

更新组织中的代码安全配置。

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

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

"更新代码安全配置"的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

"更新代码安全配置"的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

configuration_id 整数 必需

代码安全配置的唯一标识符。

主体参数
name 字符串

代码安全配置的名称。在组织内必须唯一。

description 字符串

代码安全配置的描述

advanced_security 字符串

GitHub 高级安全性的启用状态

可以是以下之一： enabled, disabled

dependency_graph 字符串

依赖关系图的启用状态

可以是以下之一： enabled, disabled, not_set

dependency_graph_autosubmit_action 字符串

自动依赖项提交的启用状态

可以是以下之一： enabled, disabled, not_set

dependency_graph_autosubmit_action_options 对象

自动依赖项提交的功能选项

labeled_runners 布尔值

是否使用标记为“dependency-submission”的运行器或标准 GitHub 运行器。

dependabot_alerts 字符串

Dependabot 警报的启用状态

可以是以下之一： enabled, disabled, not_set

dependabot_security_updates 字符串

Dependabot 安全更新的启用状态

可以是以下之一： enabled, disabled, not_set

code_scanning_default_setup 字符串

代码扫描默认设置的启用状态

可以是以下之一： enabled, disabled, not_set

secret_scanning 字符串

密钥扫描的启用状态

可以是以下之一： enabled, disabled, not_set

secret_scanning_push_protection 字符串

密钥扫描推送保护的启用状态

可以是以下之一： enabled, disabled, not_set

secret_scanning_delegated_bypass 字符串

密钥扫描委托绕过的启用状态

可以是以下之一： enabled, disabled, not_set

secret_scanning_delegated_bypass_options 对象

密钥扫描委托绕过的功能选项

reviewers 对象数组

密钥扫描委托绕过的旁路审阅者

reviewer_id 整数 必填

作为旁路审阅者选择的团队或角色的 ID

reviewer_type 字符串 必填

旁路审阅者的类型

可以是以下之一： TEAM, ROLE

secret_scanning_validity_checks 字符串

密钥扫描有效性检查的启用状态

可以是以下之一： enabled, disabled, not_set

secret_scanning_non_provider_patterns 字符串

秘密扫描非提供程序模式的启用状态

可以是以下之一： enabled, disabled, not_set

private_vulnerability_reporting 字符串

启用私有漏洞报告的状态

可以是以下之一： enabled, disabled, not_set

enforcement 字符串

安全配置的执行状态

可以是以下之一: enforced, unenforced

"更新代码安全配置"的HTTP响应状态码

状态代码描述
200

配置更新时的响应

204

未进行任何新更新时的响应

"更新代码安全配置"的代码示例

请求示例

patch/orgs/{org}/code-security/configurations/{configuration_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/code-security/configurations/CONFIGURATION_ID \ -d '{"name":"octo-org recommended settings v2","secret_scanning":"disabled","code_scanning_default_setup":"enabled"}'

配置更新时的响应

状态：200
{ "id": 1325, "target_type": "organization", "name": "octo-org recommended settings v2", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" }

删除代码安全配置

从组织中删除所需的代码安全配置。与配置关联的仓库将保留其设置，但将不再与配置关联。

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

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

"删除代码安全配置"的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

"删除代码安全配置"的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

configuration_id 整数 必需

代码安全配置的唯一标识符。

"删除代码安全配置"的HTTP响应状态码

状态代码描述
204

返回一个没有内容的头部。

400

错误请求

403

禁止

404

资源未找到

409

冲突

"删除代码安全配置"的代码示例

请求示例

delete/orgs/{org}/code-security/configurations/{configuration_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/code-security/configurations/CONFIGURATION_ID

返回一个没有内容的头部。

状态: 204

将配置附加到仓库

将代码安全配置附加到一组仓库。如果指定的仓库已附加到配置，则它们将重新附加到提供的配置。

如果无法获得足够的 GHAS 许可证来将配置附加到仓库，则仅启用免费功能。

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

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

"将配置附加到仓库"的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

"将配置附加到仓库"的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

configuration_id 整数 必需

代码安全配置的唯一标识符。

主体参数
scope 字符串 必需

要将配置附加到的仓库类型。selected表示配置将仅附加到selected_repository_ids指定的仓库

可以是以下之一: all, all_without_configurations, public, private_or_internal, selected

selected_repository_ids 整数数组

要将配置附加到的仓库 ID 数组。仅当scope设置为selected时，才能提供仓库 ID 列表。

"将配置附加到仓库"的HTTP响应状态码

状态代码描述
202

已接受

"将配置附加到仓库"的代码示例

请求示例

post/orgs/{org}/code-security/configurations/{configuration_id}/attach
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/code-security/configurations/CONFIGURATION_ID/attach \ -d '{"scope":"selected","selected_repository_ids":[32,91]}'

已接受

状态：202

将代码安全配置设置为组织的默认配置

将代码安全配置设置为默认配置，应用于组织中的新仓库。

在创建新仓库时，此配置将默认应用于匹配的仓库类型（全部、无、公共、私有和内部）。

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

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

“将代码安全配置设置为组织的默认配置”的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

“将代码安全配置设置为组织的默认配置”的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

configuration_id 整数 必需

代码安全配置的唯一标识符。

主体参数
default_for_new_repos 字符串

指定此安全配置应默认应用于哪种类型的仓库。

可以是以下之一： all, none, private_and_internal, public

“将代码安全配置设置为组织的默认配置”的 HTTP 响应状态码

状态代码描述
200

默认值已成功更改。

403

禁止

404

资源未找到

“将代码安全配置设置为组织的默认配置”的代码示例

请求示例

put/orgs/{org}/code-security/configurations/{configuration_id}/defaults
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/code-security/configurations/CONFIGURATION_ID/defaults \ -d '{"default_for_new_repos":"all"}'

默认值已成功更改。

状态：200
{ "default_for_new_repos": "all", "configuration": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } }

获取与代码安全配置关联的仓库

列出组织中与代码安全配置关联的仓库。

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

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

“获取与代码安全配置关联的仓库”的细粒度访问令牌

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

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

  • “管理”组织权限（写入）

“获取与代码安全配置关联的仓库”的参数

标头
accept 字符串

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

路径参数
org 字符串 必填

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

configuration_id 整数 必需

代码安全配置的唯一标识符。

查询参数
per_page 整数

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

默认值： 30

before 字符串

游标，如 链接标头 中所示。如果指定，则查询仅搜索此游标之前的结果。有关更多信息，请参阅“在 REST API 中使用分页”。

after 字符串

游标，如 链接标头 中所示。如果指定，则查询仅搜索此游标之后的结果。有关更多信息，请参阅“在 REST API 中使用分页”。

status 字符串

状态的逗号分隔列表。如果指定，则仅返回具有这些附件状态的仓库。

可以是：all, attached, attaching, detached, removed, enforced, failed, updating, removed_by_enterprise

默认值： all

“获取与代码安全配置关联的仓库”的 HTTP 响应状态码

状态代码描述
200

OK

403

禁止

404

资源未找到

“获取与代码安全配置关联的仓库”的代码示例

请求示例

get/orgs/{org}/code-security/configurations/{configuration_id}/repositories
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/code-security/configurations/CONFIGURATION_ID/repositories

代码安全配置仓库示例

状态：200
[ { "status": "attached", "repository": { "value": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "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 }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } } } ]

获取与仓库关联的代码安全配置

获取管理仓库代码安全设置的代码安全配置。

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

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

“获取与仓库关联的代码安全配置”的细粒度访问令牌

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

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

  • “管理”仓库权限（读取）

“获取与仓库关联的代码安全配置”的参数

标头
accept 字符串

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

路径参数
owner 字符串 必需

仓库的账户所有者。名称不区分大小写。

repo 字符串 必需

仓库的名称，不包括 .git 扩展名。名称不区分大小写。

“获取与仓库关联的代码安全配置”的 HTTP 响应状态码

状态代码描述
200

OK

204

返回一个没有内容的头部。

304

未修改

403

禁止

404

资源未找到

“获取与仓库关联的代码安全配置”的代码示例

请求示例

get/repos/{owner}/{repo}/code-security-configuration
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/repos/OWNER/REPO/code-security-configuration

响应

状态：200
{ "status": "attached", "configuration": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } }