Get the customization template for an OIDC subject claim for a

2 parameters

ownerstringrequired

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

repostringrequired

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

3 status codes

200Status response

use_defaultbooleanrequired

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

include_claim_keysarray<string>optional

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

use_immutable_subjectbooleanoptional

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_prefixstringoptional

The current `sub` claim prefix for this repository.

400Bad Request

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 400 is returned: Bad Request. A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.sub.list({
  owner: "octocat",
  repo: "hello-world",
});

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

Request

Response

Errors