Skip to content

README.md

Latest commit

 

History

History
300 lines (212 loc) · 14.5 KB

README.md

File metadata and controls

300 lines (212 loc) · 14.5 KB

OIDCTokenManagement

(oidcTokenManagement)

Overview

Endpoints related to manage oidc identity tokens

Available Operations

deleteOrgClaims

Deletes org-level custom claims of OIDC identity tokens

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.oidcTokenManagement.deleteOrgClaims({
    claims: "<value>",
    orgID: "56c7db21-f354-44d2-8a53-d8b02d62f07c",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteOrgClaimsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteOrgClaimsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteProjectClaims

Deletes project-level custom claims of OIDC identity tokens

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.oidcTokenManagement.deleteProjectClaims({
    claims: "<value>",
    orgID: "8d31466e-45c6-467d-a12f-45793f4014a8",
    projectID: "568d1acf-09ef-41b1-a52a-93672e4182b2",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteProjectClaimsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteProjectClaimsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getOrgClaims

Fetches org-level custom claims of OIDC identity tokens

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.oidcTokenManagement.getOrgClaims({
    orgID: "faa87345-442f-4070-a007-ecf098342349",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.GetOrgClaimsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetOrgClaimsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getProjectClaims

Fetches project-level custom claims of OIDC identity tokens

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.oidcTokenManagement.getProjectClaims({
    orgID: "01345488-5416-440e-9811-7333cda41eee",
    projectID: "17124405-51b9-4707-91e2-d3024606dad9",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.GetProjectClaimsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetProjectClaimsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

patchOrgClaims

Creates/Updates org-level custom claims of OIDC identity tokens

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.oidcTokenManagement.patchOrgClaims({
    patchClaimsRequest: {
      audience: [
        "<value>",
      ],
    },
    orgID: "b6c03243-08db-481d-a939-b2ebcfa7ef13",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.PatchOrgClaimsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PatchOrgClaimsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

patchProjectClaims

Creates/Updates project-level custom claims of OIDC identity tokens

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.oidcTokenManagement.patchProjectClaims({
    patchClaimsRequest: {
      audience: [
        "<value>",
      ],
    },
    orgID: "ddf25b42-5814-4fe1-af2a-ce9e5283bd11",
    projectID: "9732a915-1836-4aa8-a323-5ad82ba63480",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.PatchProjectClaimsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PatchProjectClaimsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /