此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-09-25. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持。
GitHub Actions OIDC 的 REST API 终结点
使用 REST API 与 GitHub Actions 中 OIDC 使用者声明的 JWT 交互。
关于 GitHub Actions OIDC
你可以使用 REST API 为 OpenID Connect (OIDC) 主题声明查询与管理自定义模板。 有关详细信息,请参阅“关于使用 OpenID Connect 进行安全强化”。
Get the customization template for an OIDC subject claim for an organization
Gets the customization template for an OpenID Connect (OIDC) subject claim.
OAuth app tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
“Get the customization template for an OIDC subject claim for an organization”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Administration" organization permissions (read)
“Get the customization template for an OIDC subject claim for an organization”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
“Get the customization template for an OIDC subject claim for an organization”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | A JSON serialized template for OIDC subject claim customization |
“Get the customization template for an OIDC subject claim for an organization”的示例代码
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/sub
A JSON serialized template for OIDC subject claim customization
Set the customization template for an OIDC subject claim for an organization
Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
OAuth app tokens and personal access tokens (classic) need the write:org
scope to use this endpoint.
“Set the customization template for an OIDC subject claim for an organization”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Administration" organization permissions (write)
“Set the customization template for an OIDC subject claim for an organization”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
名称, 类型, 说明 |
---|
include_claim_keys array of strings 必须Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
“Set the customization template for an OIDC subject claim for an organization”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
201 | Empty response |
403 | Forbidden |
404 | Resource not found |
“Set the customization template for an OIDC subject claim for an organization”的示例代码
请求示例
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/sub \
-d '{"include_claim_keys":["repo","context"]}'
Empty response
Get the customization template for an OIDC subject claim for a repository
Gets the customization template for an OpenID Connect (OIDC) subject claim.
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
“Get the customization template for an OIDC subject claim for a repository”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Actions" repository permissions (read)
如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。
“Get the customization template for an OIDC subject claim for a repository”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
“Get the customization template for an OIDC subject claim for a repository”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | Status response |
400 | Bad Request |
404 | Resource not found |
“Get the customization template for an OIDC subject claim for a repository”的示例代码
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub
Status response
Set the customization template for an OIDC subject claim for a repository
Sets the customization template and opt-in
or opt-out
flag for an OpenID Connect (OIDC) subject claim for a repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
“Set the customization template for an OIDC subject claim for a repository”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Actions" repository permissions (write)
“Set the customization template for an OIDC subject claim for a repository”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
名称, 类型, 说明 |
---|
use_default boolean 必须Whether to use the default template or not. If |
include_claim_keys array of strings Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
“Set the customization template for an OIDC subject claim for a repository”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
201 | Empty response |
400 | Bad Request |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
“Set the customization template for an OIDC subject claim for a repository”的示例代码
请求示例
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub \
-d '{"use_default":false,"include_claim_keys":["repo","context"]}'
Empty response