Puntos de conexión de API REST para Acciones de GitHub OIDC
Usa la API REST para interactuar con los JWT de las notificaciones de sujeto de OIDC en GitHub Actions.
Acerca de OIDC en GitHub Actions
Puedes usar la API de REST para consultar y administrar una plantilla de personalización para una notificación de asunto de OpenID Connect (OIDC). Para obtener más información, vea «Acerca del fortalecimiento de seguridad con 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.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Tokens de acceso específicos para "Get the customization template for an OIDC subject claim for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (read)
Parámetros para "Get the customization template for an OIDC subject claim for an organization"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
org string RequeridoThe organization name. The name is not case sensitive. |
Códigos de estado de respuesta HTTP para "Get the customization template for an OIDC subject claim for an organization"
| status code | Descripción |
|---|---|
200 | A JSON serialized template for OIDC subject claim customization |
Ejemplos de código para "Get the customization template for an OIDC subject claim for an organization"
Ejemplo de solicitud
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/subA 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.
OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Tokens de acceso específicos para "Set the customization template for an OIDC subject claim for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" organization permissions (write)
Parámetros para "Set the customization template for an OIDC subject claim for an organization"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
org string RequeridoThe organization name. The name is not case sensitive. |
| Nombre, Tipo, Descripción |
|---|
include_claim_keys array of strings RequeridoArray of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
Códigos de estado de respuesta HTTP para "Set the customization template for an OIDC subject claim for an organization"
| status code | Descripción |
|---|---|
201 | Empty response |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Set the customization template for an OIDC subject claim for an organization"
Ejemplo de solicitud
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/actions/oidc/customization/sub \
-d '{"include_claim_keys":["repo","context"]}'Empty response
Status: 201Get the customization template for an OIDC subject claim for a repository
Gets the customization template for an OpenID Connect (OIDC) subject claim.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Tokens de acceso específicos para "Get the customization template for an OIDC subject claim for a repository"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Actions" repository permissions (read)
Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.
Parámetros para "Get the customization template for an OIDC subject claim for a repository"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
Códigos de estado de respuesta HTTP para "Get the customization template for an OIDC subject claim for a repository"
| status code | Descripción |
|---|---|
200 | Status response |
400 | Bad Request |
404 | Resource not found |
Ejemplos de código para "Get the customization template for an OIDC subject claim for a repository"
Ejemplo de solicitud
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/subStatus 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Tokens de acceso específicos para "Set the customization template for an OIDC subject claim for a repository"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Actions" repository permissions (write)
Parámetros para "Set the customization template for an OIDC subject claim for a repository"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
| Nombre, Tipo, Descripción |
|---|
use_default boolean RequeridoWhether to use the default template or not. If |
include_claim_keys array of strings Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
Códigos de estado de respuesta HTTP para "Set the customization template for an OIDC subject claim for a repository"
| status code | Descripción |
|---|---|
201 | Empty response |
400 | Bad Request |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Ejemplos de código para "Set the customization template for an OIDC subject claim for a repository"
Ejemplo de solicitud
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/oidc/customization/sub \
-d '{"use_default":false,"include_claim_keys":["repo","context"]}'Empty response
Status: 201