Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.
O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

OIDC do GitHub Actions

Use a API REST a fim de interagir com JWTs para declarações de assunto OIDC em GitHub Actions.

Get the customization template for an OIDC subject claim for an organization

Funciona com GitHub Apps

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

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP

Código de statusDescrição
200

A JSON serialized template for OIDC subject claim customization

Exemplos de código

get/orgs/{org}/actions/oidc/customization/sub
curl \ -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

Funciona com GitHub Apps

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

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Type, Descrição
include_claim_keysarray of stringsObrigatório

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

Códigos de status de resposta HTTP

Código de statusDescrição
201

Empty response

403

Forbidden

404

Resource not found

Exemplos de código

put/orgs/{org}/actions/oidc/customization/sub
curl \ -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

Funciona com GitHub Apps

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

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
ownerstringObrigatório

The account owner of the repository. The name is not case sensitive.

repostringObrigatório

The name of the repository. The name is not case sensitive.

Códigos de status de resposta HTTP

Código de statusDescrição
200

Status response

400

Bad Request

404

Resource not found

Exemplos de código

get/repos/{owner}/{repo}/actions/oidc/customization/sub
curl \ -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

Funciona com GitHub Apps

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

Cabeçalhos
Nome, Type, Descrição
acceptstring

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Type, Descrição
ownerstringObrigatório

The account owner of the repository. The name is not case sensitive.

repostringObrigatório

The name of the repository. The name is not case sensitive.

Parâmetros do corpo
Nome, Type, Descrição
use_defaultbooleanObrigatório

Whether to use the default template or not. If true, the include_claim_keys field is ignored.

include_claim_keysarray of strings

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

Códigos de status de resposta HTTP

Código de statusDescrição
201

Empty response

400

Bad Request

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemplos de código

put/repos/{owner}/{repo}/actions/oidc/customization/sub
curl \ -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