List OIDC custom property inclusions for an enterprise

GET

/enterprises/{enterprise}/actions/oidc/customization/properties/repo

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.

API method documentation

Parameters

Path Parameters

enterprise

required

string

The slug version of the enterprise name.

Responses

200

A JSON array of OIDC custom property inclusions

Media type application/json

Array<object>

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

Example default

[
  {
    "custom_property_name": "environment",
    "inclusion_source": "enterprise"
  },
  {
    "custom_property_name": "team",
    "inclusion_source": "enterprise"
  }
]

403

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"
}

404

Resource not found

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"
}