OIDC GitHub Actions
Utilisez l’API REST pour interagir avec les JWT pour les revendications d’objet OIDC dans GitHub Actions.
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.
Paramètres pour « Get the customization template for an OIDC subject claim for an organization »
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
orgstringObligatoireThe organization name. The name is not case sensitive. |
Codes d’état de la réponse HTTP pour « Get the customization template for an OIDC subject claim for an organization »
| Code d’état | Description |
|---|---|
200 | A JSON serialized template for OIDC subject claim customization |
Exemples de code pour « 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>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/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.
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.
Paramètres pour « Set the customization template for an OIDC subject claim for an organization »
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
orgstringObligatoireThe organization name. The name is not case sensitive. |
| Paramètres du corps |
| Nom, Type, Description |
include_claim_keysarray of stringsObligatoireArray of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
Codes d’état de la réponse HTTP pour « Set the customization template for an OIDC subject claim for an organization »
| Code d’état | Description |
|---|---|
201 | Empty response |
403 | Forbidden |
404 | Resource not found |
Exemples de code pour « 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>"\
-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
Status: 201Get 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.
Paramètres pour « Get the customization template for an OIDC subject claim for a repository »
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
Codes d’état de la réponse HTTP pour « Get the customization template for an OIDC subject claim for a repository »
| Code d’état | Description |
|---|---|
200 | Status response |
400 | Bad Request |
404 | Resource not found |
Exemples de code pour « 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>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/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.
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.
Paramètres pour « Set the customization template for an OIDC subject claim for a repository »
| En-têtes |
|---|
| Nom, Type, Description |
acceptstringSetting to |
| Paramètres de chemin d’accès |
| Nom, Type, Description |
ownerstringObligatoireThe account owner of the repository. The name is not case sensitive. |
repostringObligatoireThe name of the repository. The name is not case sensitive. |
| Paramètres du corps |
| Nom, Type, Description |
use_defaultbooleanObligatoireWhether to use the default template or not. If |
include_claim_keysarray of stringsArray of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
Codes d’état de la réponse HTTP pour « Set the customization template for an OIDC subject claim for a repository »
| Code d’état | Description |
|---|---|
201 | Empty response |
400 | Bad Request |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemples de code pour « 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>"\
-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
Status: 201