Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Compliance evidence API

4 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

compliance.current

List the connected compliance platforms, what each receives and its recent pushes

POST/api/v1/manage/compliance/current

const result = await shuffl.compliance.current();
Request fields (none)

This operation takes no input.

Response object
  • catalog object[] required
    • blurb string required
    • docsHref string required
    • fields object[] required
      • help string optional
      • id string required
      • label string required
      • optional true optional
      • options object[] optional
        • label string required
        • value string required
      • secret true optional
    • id "drata" | "vanta" required
    • name string required
    • steps string[] required
  • connections object[] required
    • createdAt string required
    • enabled boolean required
    • evidence object required
      • people boolean required
      • policy_acknowledgements boolean required
    • id string required
    • label string required
    • lastError null | string required
    • lastPushAt null | string required
    • lastSuccessAt null | string required
    • offered "people" | "policy_acknowledgements"[] required
    • provider string required
    • providerName string required
    • pushes object[] required
      • counts object required
        • people number optional
        • policy_acknowledgements number optional
      • createdAt string required
      • errorCode null | string required
      • finishedAt null | string required
      • id string required
      • kinds "people" | "policy_acknowledgements"[] required
      • status "failed" | "running" | "succeeded" required
      • statusLabel string required
      • trigger "connect" | "manual" | "schedule" required
    • settings object required
    • status "connected" | "disconnected" | "needs_attention" required
  • evidence object[] required
    • carries string required
    • kind "people" | "policy_acknowledgements" required
    • label string required

compliance.disconnect

Disconnect a compliance platform; pushes stop at once

POST/api/v1/manage/compliance/disconnect

const result = await shuffl.compliance.disconnect({
  "connectionId": "<connectionId>",
  "confirm": "compliance.disconnect",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • connectionId string required
  • confirm "compliance.disconnect" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • catalog object[] required
      • blurb string required
      • docsHref string required
      • fields object[] required
        • help string optional
        • id string required
        • label string required
        • optional true optional
        • options object[] optional
        • secret true optional
      • id "drata" | "vanta" required
      • name string required
      • steps string[] required
    • connections object[] required
      • createdAt string required
      • enabled boolean required
      • evidence object required
        • people boolean required
        • policy_acknowledgements boolean required
      • id string required
      • label string required
      • lastError null | string required
      • lastPushAt null | string required
      • lastSuccessAt null | string required
      • offered "people" | "policy_acknowledgements"[] required
      • provider string required
      • providerName string required
      • pushes object[] required
        • counts object required
        • createdAt string required
        • errorCode null | string required
        • finishedAt null | string required
        • id string required
        • kinds "people" | "policy_acknowledgements"[] required
        • status "failed" | "running" | "succeeded" required
        • statusLabel string required
        • trigger "connect" | "manual" | "schedule" required
      • settings object required
      • status "connected" | "disconnected" | "needs_attention" required
    • evidence object[] required
      • carries string required
      • kind "people" | "policy_acknowledgements" required
      • label string required

compliance.pushNow

Send the evidence a compliance platform is set to receive now

POST/api/v1/manage/compliance/pushNow

  • Write
  • Permission compliance.pushNow
  • Needs a requestKey
  • Needs confirm set to compliance.pushNow
const result = await shuffl.compliance.pushNow({
  "connectionId": "<connectionId>",
  "requestKey": "a-new-unique-key",
  "confirm": "compliance.pushNow"
});
Request fields (3)
  • connectionId string required
  • requestKey string required1 to 128 characters
  • confirm "compliance.pushNow" required
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • push null | object required
      • counts object required
        • people number optional
        • policy_acknowledgements number optional
      • createdAt string required
      • errorCode null | string required
      • finishedAt null | string required
      • id string required
      • kinds "people" | "policy_acknowledgements"[] required
      • status "failed" | "running" | "succeeded" required
      • statusLabel string required
      • trigger "connect" | "manual" | "schedule" required
    • view object required
      • catalog object[] required
        • blurb string required
        • docsHref string required
        • fields object[] required
        • id "drata" | "vanta" required
        • name string required
        • steps string[] required
      • connections object[] required
        • createdAt string required
        • enabled boolean required
        • evidence object required
        • id string required
        • label string required
        • lastError null | string required
        • lastPushAt null | string required
        • lastSuccessAt null | string required
        • offered "people" | "policy_acknowledgements"[] required
        • provider string required
        • providerName string required
        • pushes object[] required
        • settings object required
        • status "connected" | "disconnected" | "needs_attention" required
      • evidence object[] required
        • carries string required
        • kind "people" | "policy_acknowledgements" required
        • label string required

compliance.setEvidence

Choose which evidence a compliance platform receives, or pause sending

POST/api/v1/manage/compliance/setEvidence

const result = await shuffl.compliance.setEvidence({
  "connectionId": "<connectionId>",
  "confirm": "compliance.setEvidence",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • connectionId string required
  • enabled false | true optional
  • evidence object optional
    • people false | true optional
    • policy_acknowledgements false | true optional
  • confirm "compliance.setEvidence" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • catalog object[] required
      • blurb string required
      • docsHref string required
      • fields object[] required
        • help string optional
        • id string required
        • label string required
        • optional true optional
        • options object[] optional
        • secret true optional
      • id "drata" | "vanta" required
      • name string required
      • steps string[] required
    • connections object[] required
      • createdAt string required
      • enabled boolean required
      • evidence object required
        • people boolean required
        • policy_acknowledgements boolean required
      • id string required
      • label string required
      • lastError null | string required
      • lastPushAt null | string required
      • lastSuccessAt null | string required
      • offered "people" | "policy_acknowledgements"[] required
      • provider string required
      • providerName string required
      • pushes object[] required
        • counts object required
        • createdAt string required
        • errorCode null | string required
        • finishedAt null | string required
        • id string required
        • kinds "people" | "policy_acknowledgements"[] required
        • status "failed" | "running" | "succeeded" required
        • statusLabel string required
        • trigger "connect" | "manual" | "schedule" required
      • settings object required
      • status "connected" | "disconnected" | "needs_attention" required
    • evidence object[] required
      • carries string required
      • kind "people" | "policy_acknowledgements" required
      • label string required