actions

Get the customization template for an OIDC subject claim for a repository

Changed on

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.

get/repos/{owner}/{repo}/actions/oidc/customization/sub

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/actions/oidc/customization/sub
  • Auth: none declared

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Response

Status response

use_defaultboolean required

Whether to use the default template or not. If true, the include_claim_keys field is ignored.

include_claim_keysstring[]

Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.

use_immutable_subjectboolean

Whether the repository has opted in to the immutable OIDC subject claim format. When true, OIDC tokens will use a stable, repository-ID-based sub claim. If not set at the repository level, falls back to the organization-level setting.

sub_claim_prefixstring

The current sub claim prefix for this repository.

Changes

  • 2022-11-2856720da94b9aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status