GitHub Actions OIDC
REST API를 사용하여 GitHub Actions에서 OIDC 주체 클레임에 대한 JWT와 상호 작용합니다.
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"에 대한 매개 변수
헤더 |
---|
이름, 형식, Description |
accept string Setting to |
경로 매개 변수 |
이름, 형식, Description |
org string 필수The organization name. The name is not case sensitive. |
"Get the customization template for an OIDC subject claim for an organization"에 대한 HTTP 응답 상태 코드
상태 코드 | Description |
---|---|
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>" \
http(s)://HOSTNAME/api/v3/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"에 대한 매개 변수
헤더 |
---|
이름, 형식, Description |
accept string Setting to |
경로 매개 변수 |
이름, 형식, Description |
org string 필수The organization name. The name is not case sensitive. |
본문 매개 변수 |
이름, 형식, Description |
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 응답 상태 코드
상태 코드 | Description |
---|---|
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>" \
http(s)://HOSTNAME/api/v3/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"에 대한 매개 변수
헤더 |
---|
이름, 형식, Description |
accept string Setting to |
경로 매개 변수 |
이름, 형식, Description |
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 응답 상태 코드
상태 코드 | Description |
---|---|
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>" \
http(s)://HOSTNAME/api/v3/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"에 대한 매개 변수
헤더 |
---|
이름, 형식, Description |
accept string Setting to |
경로 매개 변수 |
이름, 형식, Description |
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. |
본문 매개 변수 |
이름, 형식, Description |
use_default boolean 필수Whether to use the default template or not. |
"Set the customization template for an OIDC subject claim for a repository"에 대한 HTTP 응답 상태 코드
상태 코드 | Description |
---|---|
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>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub \
-d '{"use_default":true}'
Empty response
Status: 201