OIDC do GitHub Actions
Use a API REST a fim de interagir com JWTs para declarações de assunto OIDC em GitHub Actions.
Sobre o OIDC do GitHub Actions
Você pode usar a API REST para consultar e gerenciar um modelo de personalização para uma declaração de assunto do OpenID Connect (OIDC). Para obter mais informações, confira "Sobre o enrijecimento de segurança com o 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.
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.
Parâmetros para "Get the customization template for an OIDC subject claim for an organization"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get the customization template for an OIDC subject claim for an organization"
Código de status | Descrição |
---|---|
200 | A JSON serialized template for OIDC subject claim customization |
Exemplos de código para "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.
Parâmetros para "Set the customization template for an OIDC subject claim for an organization"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Type, Descrição |
---|
include_claim_keys array of strings ObrigatórioArray of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
Códigos de status de resposta HTTP para "Set the customization template for an OIDC subject claim for an organization"
Código de status | Descrição |
---|---|
201 | Empty response |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "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.
Parâmetros para "Get the customization template for an OIDC subject claim for a repository"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Códigos de status de resposta HTTP para "Get the customization template for an OIDC subject claim for a repository"
Código de status | Descrição |
---|---|
200 | Status response |
400 | Bad Request |
404 | Resource not found |
Exemplos de código para "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.
Parâmetros para "Set the customization template for an OIDC subject claim for a repository"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Nome, Type, Descrição |
---|
use_default boolean ObrigatórioWhether to use the default template or not. |
Códigos de status de resposta HTTP para "Set the customization template for an OIDC subject claim for a repository"
Código de status | Descrição |
---|---|
201 | Empty response |
400 | Bad Request |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "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