Create an OIDC custom property inclusion for an organization

POST

/orgs/{org}/actions/oidc/customization/properties/repo

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.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Request Body^required

Media typeapplication/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

Exampledefault

{
  "custom_property_name": "environment"
}

Responses

201

OIDC custom property inclusion created

Media typeapplication/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

Allowed values: organization enterprise

Examples

Exampledefault

{
  "custom_property_name": "environment"
}

400

Invalid input

403

Forbidden

Media typeapplication/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"
}

422

Property inclusion already exists