oidc_custom_property_inclusions

Creates, updates, deletes, gets or lists an oidc_custom_property_inclusions resource.

Overview

Name	oidc_custom_property_inclusions
Type	Resource
Id	github.oidc.oidc_custom_property_inclusions

Fields

The following fields are returned by SELECT queries:

list_oidc_custom_property_inclusions_for_enterprise

A JSON array of OIDC custom property inclusions

Name	Datatype	Description
custom_property_name	string	The name of the custom property that is included in the OIDC token
inclusion_source	string	Whether the inclusion was defined at the organization or enterprise level (organization, enterprise) (example: organization)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_oidc_custom_property_inclusions_for_enterprise	select	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.
create_oidc_custom_property_inclusion_for_enterprise	insert	enterprise, custom_property_name		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.
delete_oidc_custom_property_inclusion_for_enterprise	delete	enterprise, custom_property_name		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
custom_property_name	string	The name of the custom property to remove from OIDC token inclusion
enterprise	string	The slug version of the enterprise name.

SELECT examples

list_oidc_custom_property_inclusions_for_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.

SELECT
custom_property_name,
inclusion_source
FROM github.oidc.oidc_custom_property_inclusions
WHERE enterprise = '{{ enterprise }}' -- required
;

INSERT examples

create_oidc_custom_property_inclusion_for_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.

INSERT INTO github.oidc.oidc_custom_property_inclusions (
custom_property_name,
enterprise
)
SELECT 
'{{ custom_property_name }}' /* required */,
'{{ enterprise }}'
RETURNING
custom_property_name,
inclusion_source
;

Manifest

# Description fields are for documentation purposes
- name: oidc_custom_property_inclusions
props:
  - name: enterprise
    value: "{{ enterprise }}"
    description: Required parameter for the oidc_custom_property_inclusions resource.
  - name: custom_property_name
    value: "{{ custom_property_name }}"
    description: |
      The name of the custom property to include in the OIDC token

DELETE examples

delete_oidc_custom_property_inclusion_for_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.

DELETE FROM github.oidc.oidc_custom_property_inclusions
WHERE enterprise = '{{ enterprise }}' --required
AND custom_property_name = '{{ custom_property_name }}' --required
;