oidc

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

Overview

Name	oidc
Type	Resource
Id	github.actions.oidc

Fields

The following fields are returned by SELECT queries:

get_custom_oidc_sub_claim_for_repo

Status response

Name	Datatype	Description
include_claim_keys	array	Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
use_default	boolean	Whether to use the default template or not. If true, the include_claim_keys field is ignored.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_oidc_sub_claim_for_repo	select	owner, repo		Gets the customization template for an OpenID Connect (OIDC) subject claim. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
set_custom_oidc_sub_claim_for_repo	replace	owner, repo, use_default		Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository. OAuth app tokens and personal access tokens (classic) need the repo 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
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get_custom_oidc_sub_claim_for_repo

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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

SELECT
include_claim_keys,
use_default
FROM github.actions.oidc
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;

REPLACE examples

set_custom_oidc_sub_claim_for_repo

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

REPLACE github.actions.oidc
SET 
use_default = {{ use_default }},
include_claim_keys = '{{ include_claim_keys }}'
WHERE 
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND use_default = {{ use_default }} --required;