REST-API-Endpunkte für GitHub Actions OIDC
Verwenden Sie die REST-API, um mit JWTs für OIDC-Subjektansprüche in GitHub Actions zu interagieren.
Informationen zu GitHub Actions OIDC
Sie können die REST-API verwenden, um eine Anpassungsvorlage für einen OpenID Connect (OIDC)-Antragstelleranspruch abzufragen und zu verwalten. Weitere Informationen finden Sie unter OpenID Connect.
Set the GitHub Actions OIDC custom issuer policy for an enterprise
Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Feingranulierte Zugriffstoken für "Set the GitHub Actions OIDC custom issuer policy for an enterprise"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Enterprise administration" enterprise permissions (write)
Parameter für „Set the GitHub Actions OIDC custom issuer policy for an enterprise“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
enterprise string ErforderlichThe slug version of the enterprise name. |
| Name, Typ, BESCHREIBUNG |
|---|
include_enterprise_slug boolean Whether the enterprise customer requested a custom issuer URL. |
HTTP-Antwortstatuscodes für „Set the GitHub Actions OIDC custom issuer policy for an enterprise“
| Statuscode | BESCHREIBUNG |
|---|---|
204 | No Content |
Codebeispiele für „Set the GitHub Actions OIDC custom issuer policy for an enterprise“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/oidc/customization/issuer \
-d '{"include_enterprise_slug":true}'Response
Status: 204List OIDC custom property inclusions for an enterprise
Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Feingranulierte Zugriffstoken für "List OIDC custom property inclusions for an enterprise"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Enterprise administration" enterprise permissions (read)
Parameter für „List OIDC custom property inclusions for an enterprise“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
enterprise string ErforderlichThe slug version of the enterprise name. |
HTTP-Antwortstatuscodes für „List OIDC custom property inclusions for an enterprise“
| Statuscode | BESCHREIBUNG |
|---|---|
200 | A JSON array of OIDC custom property inclusions |
403 | Forbidden |
404 | Resource not found |
Codebeispiele für „List OIDC custom property inclusions for an enterprise“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/oidc/customization/properties/repoA JSON array of OIDC custom property inclusions
Status: 200[
{
"custom_property_name": "environment",
"inclusion_source": "enterprise"
},
{
"custom_property_name": "team",
"inclusion_source": "enterprise"
}
]Create an OIDC custom property inclusion for an enterprise
Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Feingranulierte Zugriffstoken für "Create an OIDC custom property inclusion for an enterprise"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Enterprise administration" enterprise permissions (write)
Parameter für „Create an OIDC custom property inclusion for an enterprise“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
enterprise string ErforderlichThe slug version of the enterprise name. |
| Name, Typ, BESCHREIBUNG |
|---|
custom_property_name string ErforderlichThe name of the custom property to include in the OIDC token |
HTTP-Antwortstatuscodes für „Create an OIDC custom property inclusion for an enterprise“
| Statuscode | BESCHREIBUNG |
|---|---|
201 | OIDC custom property inclusion created |
400 | Invalid input |
403 | Forbidden |
422 | Property inclusion already exists |
Codebeispiele für „Create an OIDC custom property inclusion for an enterprise“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/oidc/customization/properties/repo \
-d '{"custom_property_name":"environment"}'OIDC custom property inclusion created
Status: 201{
"custom_property_name": "environment"
}Delete an OIDC custom property inclusion for an enterprise
Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise.
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Feingranulierte Zugriffstoken für "Delete an OIDC custom property inclusion for an enterprise"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Enterprise administration" enterprise permissions (write)
Parameter für „Delete an OIDC custom property inclusion for an enterprise“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
enterprise string ErforderlichThe slug version of the enterprise name. |
custom_property_name string ErforderlichThe name of the custom property to remove from OIDC token inclusion |
HTTP-Antwortstatuscodes für „Delete an OIDC custom property inclusion for an enterprise“
| Statuscode | BESCHREIBUNG |
|---|---|
204 | OIDC custom property inclusion deleted |
400 | Invalid input |
403 | Forbidden |
404 | Property inclusion not found |
Codebeispiele für „Delete an OIDC custom property inclusion for an enterprise“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/oidc/customization/properties/repo/CUSTOM_PROPERTY_NAMEOIDC custom property inclusion deleted
Status: 204List OIDC custom property inclusions for an organization
Lists the repository custom properties that are included in the OIDC token for repository actions in an organization.
OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Feingranulierte Zugriffstoken für "List OIDC custom property inclusions for an organization"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Administration" organization permissions (read)
Parameter für „List OIDC custom property inclusions for an organization“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
org string ErforderlichThe organization name. The name is not case sensitive. |
HTTP-Antwortstatuscodes für „List OIDC custom property inclusions for an organization“
| Statuscode | BESCHREIBUNG |
|---|---|
200 | A JSON array of OIDC custom property inclusions |
403 | Forbidden |
404 | Resource not found |
Codebeispiele für „List OIDC custom property inclusions for an organization“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/oidc/customization/properties/repoA JSON array of OIDC custom property inclusions
Status: 200[
{
"property_name": "environment"
},
{
"property_name": "team"
}
]Create an OIDC custom property inclusion for an organization
Adds a repository custom property to be included in the OIDC token for repository actions in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Feingranulierte Zugriffstoken für "Create an OIDC custom property inclusion for an organization"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Administration" organization permissions (write)
Parameter für „Create an OIDC custom property inclusion for an organization“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
org string ErforderlichThe organization name. The name is not case sensitive. |
| Name, Typ, BESCHREIBUNG |
|---|
custom_property_name string ErforderlichThe name of the custom property to include in the OIDC token |
HTTP-Antwortstatuscodes für „Create an OIDC custom property inclusion for an organization“
| Statuscode | BESCHREIBUNG |
|---|---|
201 | OIDC custom property inclusion created |
400 | Invalid input |
403 | Forbidden |
422 | Property inclusion already exists |
Codebeispiele für „Create an OIDC custom property inclusion for an organization“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/oidc/customization/properties/repo \
-d '{"custom_property_name":"environment"}'OIDC custom property inclusion created
Status: 201{
"custom_property_name": "environment"
}Delete an OIDC custom property inclusion for an organization
Removes a repository custom property from being included in the OIDC token for repository actions in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Feingranulierte Zugriffstoken für "Delete an OIDC custom property inclusion for an organization"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Administration" organization permissions (write)
Parameter für „Delete an OIDC custom property inclusion for an organization“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
org string ErforderlichThe organization name. The name is not case sensitive. |
custom_property_name string ErforderlichThe name of the custom property to remove from OIDC token inclusion |
HTTP-Antwortstatuscodes für „Delete an OIDC custom property inclusion for an organization“
| Statuscode | BESCHREIBUNG |
|---|---|
204 | OIDC custom property inclusion deleted |
400 | Invalid input |
403 | Forbidden |
404 | Property inclusion not found |
Codebeispiele für „Delete an OIDC custom property inclusion for an organization“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/oidc/customization/properties/repo/CUSTOM_PROPERTY_NAMEOIDC custom property inclusion deleted
Status: 204Get 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.
Feingranulierte Zugriffstoken für "Get the customization template for an OIDC subject claim for an organization"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Administration" organization permissions (read)
Parameter für „Get the customization template for an OIDC subject claim for an organization“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
org string ErforderlichThe organization name. The name is not case sensitive. |
HTTP-Antwortstatuscodes für „Get the customization template for an OIDC subject claim for an organization“
| Statuscode | BESCHREIBUNG |
|---|---|
200 | A JSON serialized template for OIDC subject claim customization |
Codebeispiele für „Get the customization template for an OIDC subject claim for an organization“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
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.
OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Feingranulierte Zugriffstoken für "Set the customization template for an OIDC subject claim for an organization"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Administration" organization permissions (write)
Parameter für „Set the customization template for an OIDC subject claim for an organization“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
org string ErforderlichThe organization name. The name is not case sensitive. |
| Name, Typ, BESCHREIBUNG |
|---|
include_claim_keys array of strings ErforderlichArray of unique strings. Each claim key can only contain alphanumeric characters and underscores. |
HTTP-Antwortstatuscodes für „Set the customization template for an OIDC subject claim for an organization“
| Statuscode | BESCHREIBUNG |
|---|---|
201 | Empty response |
403 | Forbidden |
404 | Resource not found |
Codebeispiele für „Set the customization template for an OIDC subject claim for an organization“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
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.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Feingranulierte Zugriffstoken für "Get the customization template for an OIDC subject claim for a repository"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Actions" repository permissions (read)
Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.
Parameter für „Get the customization template for an OIDC subject claim for a repository“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
HTTP-Antwortstatuscodes für „Get the customization template for an OIDC subject claim for a repository“
| Statuscode | BESCHREIBUNG |
|---|---|
200 | Status response |
400 | Bad Request |
404 | Resource not found |
Codebeispiele für „Get the customization template for an OIDC subject claim for a repository“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Feingranulierte Zugriffstoken für "Set the customization template for an OIDC subject claim for a repository"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Actions" repository permissions (write)
Parameter für „Set the customization template for an OIDC subject claim for a repository“
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
| Name, Typ, BESCHREIBUNG |
|---|
use_default boolean ErforderlichWhether 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. |
HTTP-Antwortstatuscodes für „Set the customization template for an OIDC subject claim for a repository“
| Statuscode | BESCHREIBUNG |
|---|---|
201 | Empty response |
400 | Bad Request |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Codebeispiele für „Set the customization template for an OIDC subject claim for a repository“
Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.
Anforderungsbeispiel
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/repos/OWNER/REPO/actions/oidc/customization/sub \
-d '{"use_default":false,"include_claim_keys":["repo","context"]}'Empty response
Status: 201