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.

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

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Request Body^required

Media typeapplication/json

Actions OIDC Subject customization

Actions OIDC Subject customization

object

include_claim_keys

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

Array<string>

use_immutable_subject

Whether to opt in to the immutable OIDC subject claim format for the organization. When true, new OIDC tokens will use a stable, repository-ID-based sub claim instead of the name-based format.

boolean

Examples

Exampledefault

{
  "include_claim_keys": [
    "repo",
    "context"
  ]
}

Responses

201

Empty response

Media typeapplication/json

Empty Object

An object without any properties.

object

Examples

Exampledefault

null

403

Forbidden

Media typeapplication/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 typeapplication/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"
}