Create an OIDC custom property inclusion for an enterprise
POST
/enterprises/{enterprise}/actions/oidc/customization/properties/repo
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.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ” enterprise
required
string
The slug version of the enterprise name.
Request Body required
Section titled “ Request Body required ” Media type application/json
Actions OIDC Custom Property Inclusion Input
Input for creating an OIDC custom property inclusion
object
custom_property_name
required
The name of the custom property to include in the OIDC token
string
Examples
Example default
{ "custom_property_name": "environment"}Responses
Section titled “ Responses ”OIDC custom property inclusion created
Media type application/json
Actions OIDC Custom Property Inclusion
An OIDC custom property inclusion for repository properties
object
custom_property_name
required
The name of the custom property that is included in the OIDC token
string
inclusion_source
required
Whether the inclusion was defined at the organization or enterprise level
string
Examples
Example default
{ "custom_property_name": "environment"}Invalid input
Forbidden
Media type application/json
Basic Error
Basic Error
object
message
string
documentation_url
string
url
string
status
string
Example generated
{ "message": "example", "documentation_url": "example", "url": "example", "status": "example"}Property inclusion already exists