GitHub Actions OIDC 的 REST API 端点

关于 GitHub Actions OIDC

您可以使用 REST API 查询和管理 OpenID Connect (OIDC) 主题声明的自定义模板。有关更多信息，请参阅 "关于使用 OpenID Connect 加固安全."

获取组织的 OIDC 主题声明自定义模板

获取 OpenID Connect (OIDC) 主题声明的自定义模板。

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

用于“获取组织的 OIDC 主题声明自定义模板”的细粒度访问令牌

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

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

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

“获取组织的 OIDC 主题声明自定义模板”的参数

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

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

“获取组织的 OIDC 主题声明自定义模板”的 HTTP 响应状态码

状态码	描述
`200`	用于 OIDC 主题声明自定义的 JSON 序列化模板

“获取组织的 OIDC 主题声明自定义模板”的代码示例

请求示例

get/orgs/{org}/actions/oidc/customization/sub

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/actions/oidc/customization/sub

用于 OIDC 主题声明自定义的 JSON 序列化模板

状态：200

{ "include_claim_keys": [ "repo", "context" ] }

为组织设置 OIDC 主题声明的自定义模板

创建或更新 OpenID Connect (OIDC) 主题声明的自定义模板。

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

用于“为组织设置 OIDC 主题声明的自定义模板”的细粒度访问令牌

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

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

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

用于“为组织设置 OIDC 主题声明的自定义模板”的参数

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

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

正文参数
名称、类型、描述
`include_claim_keys` 字符串数组必需唯一字符串数组。每个声明键只能包含字母数字字符和下划线。

用于“为组织设置 OIDC 主题声明的自定义模板”的 HTTP 响应状态代码

状态码	描述
`201`	空响应
`403`	禁止
`404`	资源未找到

用于“为组织设置 OIDC 主题声明的自定义模板”的代码示例

请求示例

put/orgs/{org}/actions/oidc/customization/sub

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/actions/oidc/customization/sub \ -d '{"include_claim_keys":["repo","context"]}'

空响应

状态：201

获取仓库的 OIDC 主题声明的自定义模板

获取 OpenID Connect (OIDC) 主题声明的自定义模板。

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

用于“获取仓库的 OIDC 主题声明的自定义模板”的细粒度访问令牌

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

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

“操作”仓库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

用于“获取仓库的 OIDC 主题声明的自定义模板”的参数

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

路径参数
名称、类型、描述
`owner` 字符串必需仓库的帐户所有者。名称不区分大小写。
`repo` 字符串必需仓库名称，不包括`.git`扩展名。名称不区分大小写。

“获取仓库的 OIDC 主题声明的自定义模板”的 HTTP 响应状态代码

状态码	描述
`200`	状态响应
`400`	错误请求
`404`	资源未找到

“获取仓库的 OIDC 主题声明的自定义模板”的代码示例

请求示例

get/repos/{owner}/{repo}/actions/oidc/customization/sub

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/actions/oidc/customization/sub

状态响应

状态：200

{ "use_default": false, "include_claim_keys": [ "repo", "context" ] }

设置仓库的 OIDC 主题声明的自定义模板

设置仓库的 OpenID Connect (OIDC) 主题声明的自定义模板和opt-in或opt-out标志。

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

“设置仓库的 OIDC 主题声明的自定义模板”的细粒度访问令牌

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

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

“操作”仓库权限（写入）

“设置仓库的 OIDC 主题声明的自定义模板”的参数

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

路径参数
名称、类型、描述
`owner` 字符串必需仓库的帐户所有者。名称不区分大小写。
`repo` 字符串必需仓库名称，不包括`.git`扩展名。名称不区分大小写。

正文参数
名称、类型、描述
`use_default` 布尔值必需是否使用默认模板。如果为`true`，则忽略`include_claim_keys`字段。
`include_claim_keys` 字符串数组唯一字符串数组。每个声明键只能包含字母数字字符和下划线。

“设置仓库的 OIDC 主题声明的自定义模板”的 HTTP 响应状态代码

状态码	描述
`201`	空响应
`400`	错误请求
`404`	资源未找到
`422`	验证失败，或端点被垃圾邮件攻击。

“设置仓库的 OIDC 主题声明的自定义模板”的代码示例

请求示例

put/repos/{owner}/{repo}/actions/oidc/customization/sub

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/repos/OWNER/REPO/actions/oidc/customization/sub \ -d '{"use_default":false,"include_claim_keys":["repo","context"]}'

空响应

状态：201