← All tags

Oidc API Reference

Endpoints to manage GitHub OIDC configuration using the REST API.

8 endpoints tagged oidc, each listing its parameters and possible responses. Search or scroll the index below to jump to a specific endpoint.

No endpoints match your search.

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.

Parameters

Name	In	Required	Description
`enterprise`	path	yes	The slug version of the enterprise name.

Responses

Status	Description	Has JSON body
200	A JSON array of OIDC custom property inclusions	yes
404	Resource not found	yes
403	Forbidden	yes

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.

Parameters

Name	In	Required	Description
`enterprise`	path	yes	The slug version of the enterprise name.

Responses

Status	Description	Has JSON body
201	OIDC custom property inclusion created	yes
400	Invalid input	no
403	Forbidden	yes
422	Property inclusion already exists	no

Delete an OIDC custom property inclusion for an enterprise

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

Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise.

Parameters

Name	In	Required	Description
`enterprise`	path	yes	The slug version of the enterprise name.
`custom_property_name`	path	yes	The name of the custom property to remove from OIDC token inclusion

Responses

Status	Description	Has JSON body
204	OIDC custom property inclusion deleted	no
400	Invalid input	no
403	Forbidden	yes
404	Property inclusion not found	no

List OIDC custom property inclusions for an organization

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

Lists the repository custom properties that are included in the OIDC token for repository actions in an organization.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	A JSON array of OIDC custom property inclusions	yes
404	Resource not found	yes
403	Forbidden	yes

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.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	OIDC custom property inclusion created	yes
400	Invalid input	no
403	Forbidden	yes
422	Property inclusion already exists	no

Delete an OIDC custom property inclusion for an organization

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

Removes a repository custom property from being included in the OIDC token for repository actions in an organization.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`custom_property_name`	path	yes	The name of the custom property to remove from OIDC token inclusion

Responses

Status	Description	Has JSON body
204	OIDC custom property inclusion deleted	no
400	Invalid input	no
403	Forbidden	yes
404	Property inclusion not found	no

Get the customization template for an OIDC subject claim for an organization

GET /orgs/{org}/actions/oidc/customization/sub

Gets the customization template for an OpenID Connect (OIDC) subject claim.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	A JSON serialized template for OIDC subject claim customization	yes

Set the customization template for an OIDC subject claim for an organization

PUT /orgs/{org}/actions/oidc/customization/sub

Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Empty response	yes
404	Resource not found	yes
403	Forbidden	yes