GitHub Actions OIDC
この REST API を使って、GitHub Actions の OIDC サブジェクト要求について JWT を操作します。
Set the GitHub Actions OIDC custom issuer policy for an enterprise
Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
"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.
You must authenticate using an access token with the read:org
scope to use this endpoint.
GitHub Apps must have the organization_administration:write
permission to use this endpoint.
"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
Status: 200
{
"include_claim_keys": [
"repo",
"context"
]
}
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.
You must authenticate using an access token with the write:org
scope to use this endpoint.
GitHub Apps must have the admin:org
permission to use this endpoint.
"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
Status: 201
Get the customization template for an OIDC subject claim for a repository
Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the repo
scope to use this
endpoint. GitHub Apps must have the organization_administration:read
permission to use this endpoint.
"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. The name is not case sensitive. |
"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
Status: 200
{
"use_default": false,
"include_claim_keys": [
"repo",
"context"
]
}
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.
You must authenticate using an access token with the repo
scope to use this
endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
"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. The name is not case sensitive. |
本文のパラメーター |
名前, 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
Status: 201