GitHub Actions OIDC
The GitHub Actions OIDC API allows you to customize the JWT token claims.
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.
GitHub Apps must have the enterprise_administration:write
permission to use this endpoint.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
enterprise stringRequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
include_enterprise_slug booleanWhether the enterprise customer requested a custom issuer URL. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
204 | No Content |
Ejemplos de código
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
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
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | A JSON serialized template for OIDC subject claim customization |
Ejemplos de código
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
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
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
include_claim_keys array of stringsRequerido |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
201 | Empty response |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código
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
Status: 201
Get the opt-out flag of an OIDC subject claim customization for a repository
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
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
owner stringRequeridoThe account owner of the repository. The name is not case sensitive. |
repo stringRequeridoThe name of the repository. The name is not case sensitive. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | Status response |
400 | Bad Request |
404 | Resource not found |
Ejemplos de código
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
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
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
owner stringRequeridoThe account owner of the repository. The name is not case sensitive. |
repo stringRequeridoThe name of the repository. The name is not case sensitive. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
use_default booleanRequerido |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
201 | Empty response |
400 | Bad Request |
404 | Resource not found |
422 | Validation failed |
Ejemplos de código
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