Skip to main content

GitHub Actions OIDC

A API OIDC de GitHub Actions permite que você personalize as reivindicações do token JWT.

Set the GitHub Actions OIDC custom issuer policy for an enterprise

Works with GitHub Apps

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. GitHub Apps must have the enterprise_administration:write permission to use this endpoint.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
enterprisestringObrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Body parameters
Nome, Tipo, Descrição
include_enterprise_slugboolean

Whether the enterprise customer requested a custom issuer URL.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

put/enterprises/{enterprise}/actions/oidc/customization/issuer
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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

Works with 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

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

HTTP response status codes

Status codeDescrição
200

A JSON serialized template for OIDC subject claim customization

Amostras de código

get/orgs/{org}/actions/oidc/customization/sub
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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

Works with 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

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
orgstringObrigatório

The organization name. The name is not case sensitive.

Body parameters
Nome, Tipo, Descrição
include_claim_keysarray of stringsObrigatório

HTTP response status codes

Status codeDescrição
201

Empty response

403

Forbidden

404

Resource not found

Amostras de código

put/orgs/{org}/actions/oidc/customization/sub
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/orgs/ORG/actions/oidc/customization/sub \ -d '{"include_claim_keys":["repo","context"]}'

Empty response

Get the opt-out flag of an OIDC subject claim customization for a repository

Works with GitHub Apps

Gets the opt-out flag of a GitHub Actions OpenID Connect (OIDC) subject claim customization for a repository. 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

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, 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.

HTTP response status codes

Status codeDescrição
200

Status response

400

Bad Request

404

Resource not found

Amostras de código

get/repos/{owner}/{repo}/actions/oidc/customization/sub
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/repos/OWNER/REPO/actions/oidc/customization/sub

Status response

Status: 200
{ "use_default": false }

Set the opt-in flag of an OIDC subject claim customization for a repository

Works with GitHub Apps

Sets the opt-in or opt-out flag of a GitHub Actions OpenID Connect (OIDC) subject claim customization 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

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, 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.

Body parameters
Nome, Tipo, Descrição
use_defaultbooleanObrigatório

HTTP response status codes

Status codeDescrição
201

Empty response

400

Bad Request

404

Resource not found

422

Validation failed

Amostras de código

put/repos/{owner}/{repo}/actions/oidc/customization/sub
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/repos/OWNER/REPO/actions/oidc/customization/sub \ -d '{"use_default":false}'

Empty response

Status: 201