GitHub Actions OIDC の REST API エンドポイント
この REST API を使って、GitHub Actions の OIDC サブジェクト要求について JWT を操作します。
GitHub Actions の OIDC について
REST API を使用して、OpenID Connect (OIDC) サブジェクト要求のカスタマイズ テンプレートのクエリと管理を行うことができます。 詳しくは、「OpenID Connect を使ったセキュリティ強化について」を参照してください。
Set the GitHub Actions OIDC custom issuer policy for an enterprise
Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
"Set the GitHub Actions OIDC custom issuer policy for an enterprise" のきめ細かいアクセス トークン
このエンドポイントは、次の粒度の細かいトークンの種類で動作します:
粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:
- "Enterprise administration" business permissions (write)
"Set the GitHub Actions OIDC custom issuer policy for an enterprise" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
enterprise string 必須The slug version of the enterprise name. You can also substitute this value with the enterprise id. |
名前, Type, 説明 |
---|
include_enterprise_slug boolean Whether the enterprise customer requested a custom issuer URL. |
"Set the GitHub Actions OIDC custom issuer policy for an enterprise" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
204 | No Content |
"Set the GitHub Actions OIDC custom issuer policy for an enterprise" のコード サンプル
要求の例
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/enterprises/ENTERPRISE/actions/oidc/customization/issuer \
-d '{"include_enterprise_slug":true}'
Response
Status: 204
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" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
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" \
https://api.github.com/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" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
名前, Type, 説明 |
---|
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" \
https://api.github.com/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" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
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" \
https://api.github.com/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" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
owner string 必須The account owner of the repository. The name is not case sensitive. |
repo string 必須The name of the repository without the |
名前, Type, 説明 |
---|
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" \
https://api.github.com/repos/OWNER/REPO/actions/oidc/customization/sub \
-d '{"use_default":false,"include_claim_keys":["repo","context"]}'
Empty response