Skip to content

Latest commit

 

History

History
445 lines (315 loc) · 22 KB

README.md

File metadata and controls

445 lines (315 loc) · 22 KB

PolicyManagement

(policyManagement)

Overview

Endpoints related to managing policies and making policy decisions

Available Operations

createPolicyBundle

This endpoint replaces the current policy bundle with the provided policy bundle

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.policyManagement.createPolicyBundle({
    bundlePayload: {
      policies: {
        "key": "<value>",
      },
    },
    context: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.CreatePolicyBundleResponse>

Errors

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

getDecisionLog

This endpoint will retrieve a decision for a given decision log ID

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.policyManagement.getDecisionLog({
    context: "<value>",
    decisionID: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetDecisionLogResponse>

Errors

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

getDecisionLogPolicyBundle

This endpoint will retrieve a policy bundle for a given decision log ID

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.policyManagement.getDecisionLogPolicyBundle({
    context: "<value>",
    decisionID: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetDecisionLogPolicyBundleResponse>

Errors

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

getDecisionLogs

This endpoint will return a list of decision audit logs that were made using this owner's policies.

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.policyManagement.getDecisionLogs({
    context: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetDecisionLogsResponse>

Errors

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

getDecisionSettings

This endpoint retrieves the current decision settings (eg enable/disable policy evaluation)

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.policyManagement.getDecisionSettings({
    context: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetDecisionSettingsResponse>

Errors

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

getPolicyBundle

This endpoint will retrieve a policy bundle

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.policyManagement.getPolicyBundle({
    context: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetPolicyBundleResponse>

Errors

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

getPolicyDocument

This endpoint will retrieve a policy document.

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.policyManagement.getPolicyDocument({
    context: "<value>",
    ownerID: "<value>",
    policyName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetPolicyDocumentResponse>

Errors

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

makeDecision

This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision.

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.policyManagement.makeDecision({
    requestBody: {
      input: "<value>",
      metadata: {},
    },
    context: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.MakeDecisionResponse>

Errors

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

setDecisionSettings

This endpoint allows modifying decision settings (eg enable/disable policy evaluation)

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.policyManagement.setDecisionSettings({
    decisionSettings: {},
    context: "<value>",
    ownerID: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.SetDecisionSettingsResponse>

Errors

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