Skip to content

Integrations

Vanta

Query compliance status and manage evidence in Vanta

Vanta is a trust management platform that automates security and compliance for frameworks like SOC 2, ISO 27001, HIPAA, and GDPR. It continuously monitors your infrastructure, people, and vendors through automated tests, and centralizes the evidence auditors need.

With the Vanta integration in Sim, you can:

  • Monitor compliance posture: List frameworks with control, document, and test completion counts, and drill into individual controls and their mapped tests and evidence documents.
  • Triage failing tests: List automated compliance tests by status, framework, integration, or category, and pull the exact failing resource entities that need remediation.
  • Manage evidence documents: List and inspect evidence documents, upload evidence files with descriptions and effective dates, download previously uploaded files, and submit document collections for auditor review.
  • Track people and security tasks: List people with employment status, group membership, and outstanding security tasks (trainings, policy acceptance, background checks, device monitoring).
  • Review policies and vendors: Check policy approval status and versions, and track vendors with risk levels, contract dates, and security review schedules.
  • Stay on top of vulnerabilities: List vulnerabilities with severity and SLA deadline filters, review remediation history, and inspect the vulnerable assets behind each finding.
  • Watch device compliance: List monitored computers with screenlock, disk encryption, password manager, and antivirus check outcomes.
  • Manage risk scenarios: Query risk register scenarios with likelihood/impact scores, treatment decisions, and review status.

Create a Manage Vanta application in Vanta's Developer Console, then add a Vanta credential in Sim with its client ID, client secret, and deployment. Select that saved credential in your Vanta blocks. Sim stores the credentials securely and obtains access tokens automatically; there is no browser authorization redirect or shared Sim OAuth application to configure.

Standard Vanta deployments, including US, EU, and AU tenants, use api.vanta.com; Vanta Gov uses api.vanta-gov.com. Read operations require vanta-api.all:read; submitting documents also requires vanta-api.all:write; evidence uploads require vanta-api.documents:upload. Grant the scopes needed for your workflows when creating the application. See Vanta's authentication documentation.

The first successful connection sets this application's permissions in Sim. Every connection to that application must always use the same permissions, including after tokens expire or credentials are reconnected. Leave permissions blank on reconnect to retain the current choice. To choose different permissions, create a separate Manage Vanta application and connect it in Sim.

If your workflow entered credentials directly on a Vanta block, create and select a saved Vanta credential before running it again. Use a dedicated Vanta application for Sim: Vanta allows one active access token per application, so another client obtaining a new token can invalidate Sim's token.

Use the block

Monitor compliance frameworks, controls, and automated tests; find failing test entities; manage evidence documents including file upload, download, and submission; and track people, policies, vendors, monitored computers, vulnerabilities, and risk scenarios. Select a saved Vanta credential created with your Vanta application client ID and client secret.

Actions

Vanta List Frameworks

List the compliance frameworks (e.g., SOC 2, ISO 27001) available in a Vanta account with completion counts

Inputs and outputs

Input

ParameterTypeRequiredDescription
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
frameworksarrayFrameworks in the Vanta account
↳ idstringThe framework's unique ID
↳ displayNamestringThe framework's display name
↳ shorthandNamestringThe short version of the framework's name
↳ descriptionstringThe framework's description
↳ numControlsCompletednumberNumber of completed controls in the framework
↳ numControlsTotalnumberTotal number of controls in the framework
↳ numDocumentsPassingnumberNumber of passing documents in the framework
↳ numDocumentsTotalnumberTotal number of documents in the framework
↳ numTestsPassingnumberNumber of passing tests in the framework
↳ numTestsTotalnumberTotal number of tests in the framework
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Framework

Get a Vanta compliance framework by ID, including its requirement categories and mapped controls

Inputs and outputs

Input

ParameterTypeRequiredDescription
frameworkIdstringYesUnique ID of the framework (e.g., soc2)

Output

ParameterTypeDescription
frameworkjsonThe requested framework with requirement categories
↳ idstringThe framework's unique ID
↳ displayNamestringThe framework's display name
↳ shorthandNamestringThe short version of the framework's name
↳ descriptionstringThe framework's description
↳ numControlsCompletednumberNumber of completed controls in the framework
↳ numControlsTotalnumberTotal number of controls in the framework
↳ numDocumentsPassingnumberNumber of passing documents in the framework
↳ numDocumentsTotalnumberTotal number of documents in the framework
↳ numTestsPassingnumberNumber of passing tests in the framework
↳ numTestsTotalnumberTotal number of tests in the framework
↳ requirementCategoriesarrayThe framework's requirement categories, each with requirements and mapped controls
↳ idstringRequirement category ID
↳ namestringRequirement category name
↳ shorthandstringRequirement category short name
↳ requirementsarrayRequirements in this category, each listing its mapped controls
↳ idstringRequirement ID
↳ namestringRequirement name
↳ shorthandstringRequirement shorthand
↳ descriptionstringRequirement description
↳ controlsarrayControls mapped to the requirement
↳ idstringControl ID
↳ externalIdstringExternal control ID
↳ namestringControl name
↳ descriptionstringControl description

Vanta List Framework Controls

List the controls that belong to a specific Vanta compliance framework

Inputs and outputs

Input

ParameterTypeRequiredDescription
frameworkIdstringYesUnique ID of the framework (e.g., soc2)
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
controlsarrayControls belonging to the framework
↳ idstringThe control's unique ID
↳ externalIdstringThe control's external ID
↳ namestringThe control's name
↳ descriptionstringThe control's description
↳ sourcestringThe control source, either "Vanta" or "Custom"
↳ domainsarraySecurity domains the control belongs to
↳ ownerjsonThe control's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner
↳ rolestringThe control's GDPR role, if applicable
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ creationDatestringWhen the control was created (null for Vanta library controls)
↳ modificationDatestringWhen the control was last modified (null for Vanta library controls)
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Controls

List the security controls in a Vanta account, optionally filtered by framework

Inputs and outputs

Input

ParameterTypeRequiredDescription
frameworkMatchesAnystringNoComma-separated framework IDs to filter controls by (e.g., soc2,iso27001)
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
controlsarrayControls matching the filters
↳ idstringThe control's unique ID
↳ externalIdstringThe control's external ID
↳ namestringThe control's name
↳ descriptionstringThe control's description
↳ sourcestringThe control source, either "Vanta" or "Custom"
↳ domainsarraySecurity domains the control belongs to
↳ ownerjsonThe control's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner
↳ rolestringThe control's GDPR role, if applicable
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ creationDatestringWhen the control was created (null for Vanta library controls)
↳ modificationDatestringWhen the control was last modified (null for Vanta library controls)
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Control

Get a Vanta security control by ID, including its status and evidence pass/fail counts

Inputs and outputs

Input

ParameterTypeRequiredDescription
controlIdstringYesUnique ID of the control

Output

ParameterTypeDescription
controljsonThe requested control with status and evidence counts
↳ idstringThe control's unique ID
↳ externalIdstringThe control's external ID
↳ namestringThe control's name
↳ descriptionstringThe control's description
↳ sourcestringThe control source, either "Vanta" or "Custom"
↳ domainsarraySecurity domains the control belongs to
↳ ownerjsonThe control's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner
↳ rolestringThe control's GDPR role, if applicable
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ creationDatestringWhen the control was created (null for Vanta library controls)
↳ modificationDatestringWhen the control was last modified (null for Vanta library controls)
↳ notestringA user-created note for the control
↳ statusstringControl status (NO_EVIDENCE_MAPPED, NOT_STARTED, IN_PROGRESS, or COMPLETED)
↳ numDocumentsPassingnumberNumber of passing documents linked to the control
↳ numDocumentsTotalnumberTotal number of documents linked to the control
↳ numTestsPassingnumberNumber of passing tests linked to the control
↳ numTestsTotalnumberTotal number of tests linked to the control

Vanta List Control Tests

List the automated tests mapped to a specific Vanta control

Inputs and outputs

Input

ParameterTypeRequiredDescription
controlIdstringYesUnique ID of the control
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
testsarrayTests mapped to the control
↳ idstringThe test's unique ID
↳ namestringThe test's name
↳ descriptionstringThe test's description
↳ failureDescriptionstringThe test's failure description
↳ remediationDescriptionstringThe test's remediation description
↳ categorystringThe test's category
↳ statusstringTest run status (OK, DEACTIVATED, NEEDS_ATTENTION, IN_PROGRESS, INVALID, or NOT_APPLICABLE)
↳ integrationsarrayThe test's third-party integration dependencies
↳ lastTestRunDatestringTimestamp of the last test run
↳ latestFlipDatestringMost recent date the test flipped status
↳ versionjsonThe test's version
↳ majornumberMajor version number
↳ minornumberMinor version number
↳ deactivatedStatusInfojsonThe test's deactivation status
↳ isDeactivatedbooleanWhether the test is deactivated
↳ deactivatedReasonstringReason for deactivation
↳ lastUpdatedDatestringDate of the last deactivation status update
↳ remediationStatusInfojsonThe test's remediation status
↳ statusstringRemediation status
↳ soonestRemediateByDatestringSoonest remediate-by date
↳ itemCountnumberNumber of items needing remediation
↳ ownerjsonThe test's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Control Documents

List the evidence documents mapped to a specific Vanta control

Inputs and outputs

Input

ParameterTypeRequiredDescription
controlIdstringYesUnique ID of the control
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
documentsarrayDocuments mapped to the control
↳ idstringThe document's unique ID
↳ titlestringThe document's title
↳ descriptionstringThe document's description
↳ categorystringThe document's category
↳ ownerIdstringUser ID of the document's owner
↳ isSensitivebooleanWhether the document is sensitive
↳ uploadStatusstringDocument status ("Needs document", "Needs update", "Not relevant", or "OK")
↳ uploadStatusDatestringDate the upload status last changed
↳ urlstringURL to view the document within Vanta
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Tests

List the automated compliance tests in a Vanta account, with filters for status, framework, integration, control, owner, and category

Inputs and outputs

Input

ParameterTypeRequiredDescription
statusFilterstringNoFilter by test status: OK, DEACTIVATED, NEEDS_ATTENTION, IN_PROGRESS, INVALID, or NOT_APPLICABLE
frameworkFilterstringNoFilter by framework ID (e.g., soc2)
integrationFilterstringNoFilter by integration ID (e.g., aws)
controlFilterstringNoFilter by control ID
ownerFilterstringNoFilter by owner user ID
categoryFilterstringNoFilter by test category (e.g., ACCOUNTS_ACCESS, COMPUTERS, INFRASTRUCTURE, POLICIES, VULNERABILITY_MANAGEMENT)
isInRolloutbooleanNoFilter by whether the test is in rollout
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
testsarrayTests matching the filters
↳ idstringThe test's unique ID
↳ namestringThe test's name
↳ descriptionstringThe test's description
↳ failureDescriptionstringThe test's failure description
↳ remediationDescriptionstringThe test's remediation description
↳ categorystringThe test's category
↳ statusstringTest run status (OK, DEACTIVATED, NEEDS_ATTENTION, IN_PROGRESS, INVALID, or NOT_APPLICABLE)
↳ integrationsarrayThe test's third-party integration dependencies
↳ lastTestRunDatestringTimestamp of the last test run
↳ latestFlipDatestringMost recent date the test flipped status
↳ versionjsonThe test's version
↳ majornumberMajor version number
↳ minornumberMinor version number
↳ deactivatedStatusInfojsonThe test's deactivation status
↳ isDeactivatedbooleanWhether the test is deactivated
↳ deactivatedReasonstringReason for deactivation
↳ lastUpdatedDatestringDate of the last deactivation status update
↳ remediationStatusInfojsonThe test's remediation status
↳ statusstringRemediation status
↳ soonestRemediateByDatestringSoonest remediate-by date
↳ itemCountnumberNumber of items needing remediation
↳ ownerjsonThe test's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Test

Get a Vanta automated compliance test by ID, including its status and remediation info

Inputs and outputs

Input

ParameterTypeRequiredDescription
testIdstringYesUnique ID of the test (e.g., test-aws-cloudtrail-enabled)

Output

ParameterTypeDescription
testjsonThe requested test
↳ idstringThe test's unique ID
↳ namestringThe test's name
↳ descriptionstringThe test's description
↳ failureDescriptionstringThe test's failure description
↳ remediationDescriptionstringThe test's remediation description
↳ categorystringThe test's category
↳ statusstringTest run status (OK, DEACTIVATED, NEEDS_ATTENTION, IN_PROGRESS, INVALID, or NOT_APPLICABLE)
↳ integrationsarrayThe test's third-party integration dependencies
↳ lastTestRunDatestringTimestamp of the last test run
↳ latestFlipDatestringMost recent date the test flipped status
↳ versionjsonThe test's version
↳ majornumberMajor version number
↳ minornumberMinor version number
↳ deactivatedStatusInfojsonThe test's deactivation status
↳ isDeactivatedbooleanWhether the test is deactivated
↳ deactivatedReasonstringReason for deactivation
↳ lastUpdatedDatestringDate of the last deactivation status update
↳ remediationStatusInfojsonThe test's remediation status
↳ statusstringRemediation status
↳ soonestRemediateByDatestringSoonest remediate-by date
↳ itemCountnumberNumber of items needing remediation
↳ ownerjsonThe test's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner

Vanta List Test Entities

List the failing or deactivated resource entities for a specific Vanta test, useful for finding exactly which resources need remediation

Inputs and outputs

Input

ParameterTypeRequiredDescription
testIdstringYesUnique ID of the test (e.g., test-aws-cloudtrail-enabled)
entityStatusstringNoFilter entities by status: FAILING or DEACTIVATED
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
entitiesarrayResource entities for the test
↳ idstringIdentifier of the entity
↳ entityStatusstringEntity status (FAILING or DEACTIVATED)
↳ displayNamestringDisplay name of the entity
↳ responseTypestringResponse type of the entity
↳ deactivatedReasonstringReason for deactivation
↳ createdDatestringDate the entity was first detected
↳ lastUpdatedDatestringDate of the last update to the entity
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Documents

List the evidence documents in a Vanta account, optionally filtered by framework or document status

Inputs and outputs

Input

ParameterTypeRequiredDescription
frameworkMatchesAnystringNoComma-separated framework IDs to filter documents by (e.g., soc2,iso27001)
statusMatchesAnystringNoComma-separated document statuses to filter by: "Needs document", "Needs update", "Not relevant", "OK"
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
documentsarrayDocuments matching the filters
↳ idstringThe document's unique ID
↳ titlestringThe document's title
↳ descriptionstringThe document's description
↳ categorystringThe document's category
↳ ownerIdstringUser ID of the document's owner
↳ isSensitivebooleanWhether the document is sensitive
↳ uploadStatusstringDocument status ("Needs document", "Needs update", "Not relevant", or "OK")
↳ uploadStatusDatestringDate the upload status last changed
↳ urlstringURL to view the document within Vanta
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Document

Get a Vanta evidence document by ID, including its renewal schedule and deactivation status

Inputs and outputs

Input

ParameterTypeRequiredDescription
documentIdstringYesUnique ID of the document

Output

ParameterTypeDescription
documentjsonThe requested document
↳ idstringThe document's unique ID
↳ titlestringThe document's title
↳ descriptionstringThe document's description
↳ categorystringThe document's category
↳ ownerIdstringUser ID of the document's owner
↳ isSensitivebooleanWhether the document is sensitive
↳ uploadStatusstringDocument status ("Needs document", "Needs update", "Not relevant", or "OK")
↳ uploadStatusDatestringDate the upload status last changed
↳ urlstringURL to view the document within Vanta
↳ notestringA user note for the document
↳ nextRenewalDatestringWhen the document needs to be renewed
↳ renewalCadencestringHow often the document must be renewed
↳ reminderWindowstringReminder window ahead of the renewal date (P0D, P1D, P1W, P1M, or P3M)
↳ subscribersarrayEmails subscribed to the document
↳ deactivatedStatusjsonThe document's deactivation status
↳ isDeactivatedbooleanWhether the document is deactivated
↳ reasonstringReason the document was deactivated
↳ creationDatestringDate the document was deactivated
↳ expirationstringDate the deactivation expires

Vanta List Document Uploads

List the files uploaded to a specific Vanta evidence document

Inputs and outputs

Input

ParameterTypeRequiredDescription
documentIdstringYesUnique ID of the document
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
uploadsarrayFiles uploaded to the document
↳ idstringUnique ID of the uploaded file
↳ fileNamestringFile name of the upload
↳ titlestringTitle of the upload
↳ descriptionstringDescription of the upload
↳ mimeTypestringMIME type of the uploaded file
↳ uploadedByjsonActor who uploaded the file (a user or an application)
↳ idstringActor ID
↳ typestringActor type (USER or APPLICATION)
↳ creationDatestringDate the file was uploaded
↳ updatedDatestringDate the file was last updated
↳ deletionDatestringDate the file was deleted (null if not deleted)
↳ effectiveDatestringThe file's effective date
↳ urlstringThe file's URL
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Upload Document File

Upload an evidence file to a Vanta document. Requires credentials with the vanta-api.documents:upload scope.

Inputs and outputs

Input

ParameterTypeRequiredDescription
documentIdstringYesUnique ID of the document to attach the file to
filefileNoThe evidence file to upload
fileNamestringNoOptional file name override
mimeTypestringNoMIME type of the file (e.g., application/pdf). Applies only to the base64 upload path; a file from the File input always sends the content type resolved from storage.
descriptionstringNoDescription of the uploaded evidence (e.g., "Q3 access review evidence")
effectiveAtDatestringNoISO 8601 date indicating when the document is effective from

Output

ParameterTypeDescription
uploadjsonMetadata of the uploaded file
↳ idstringUnique ID of the uploaded file
↳ fileNamestringFile name of the upload
↳ titlestringTitle of the upload
↳ descriptionstringDescription of the upload
↳ mimeTypestringMIME type of the uploaded file
↳ uploadedByjsonActor who uploaded the file (a user or an application)
↳ idstringActor ID
↳ typestringActor type (USER or APPLICATION)
↳ creationDatestringDate the file was uploaded
↳ updatedDatestringDate the file was last updated
↳ deletionDatestringDate the file was deleted (null if not deleted)
↳ effectiveDatestringThe file's effective date
↳ urlstringThe file's URL

Vanta Download Document File

Download a file previously uploaded to a Vanta evidence document and store it in execution files

Inputs and outputs

Input

ParameterTypeRequiredDescription
documentIdstringYesUnique ID of the document
uploadedFileIdstringYesUnique ID of the uploaded file (from List Document Uploads)

Output

ParameterTypeDescription
filefileDownloaded file stored in execution files
namestringName of the downloaded file
mimeTypestringMIME type of the downloaded file
sizenumberSize of the downloaded file in bytes

Vanta Submit Document

Submit a Vanta document collection for review so uploaded evidence becomes visible to auditors. Requires credentials with write access.

Inputs and outputs

Input

ParameterTypeRequiredDescription
documentIdstringYesUnique ID of the document to submit

Output

ParameterTypeDescription
documentIdstringID of the submitted document
submittedbooleanWhether the document collection was submitted

Vanta List People

List the people tracked in a Vanta account with employment status, group membership, and security task completion

Inputs and outputs

Input

ParameterTypeRequiredDescription
emailAndNameFilterstringNoFilter people by email address or name
employmentStatusstringNoFilter by employment status: UPCOMING, CURRENT, ON_LEAVE, INACTIVE, or FORMER
groupIdsMatchesAnystringNoComma-separated group IDs to filter people by
tasksSummaryStatusMatchesAnystringNoComma-separated task summary statuses to filter by: NONE, DUE_SOON, OVERDUE, COMPLETE, PAUSED, OFFBOARDING_DUE_SOON, OFFBOARDING_OVERDUE, OFFBOARDING_COMPLETE
taskTypeMatchesAnystringNoComma-separated task types to filter by: COMPLETE_TRAININGS, ACCEPT_POLICIES, COMPLETE_CUSTOM_TASKS, COMPLETE_CUSTOM_OFFBOARDING_TASKS, INSTALL_DEVICE_MONITORING, COMPLETE_BACKGROUND_CHECKS
taskStatusMatchesAnystringNoComma-separated task statuses to filter by: COMPLETE, DUE_SOON, OVERDUE, NONE
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
peoplearrayPeople matching the filters
↳ idstringThe person's unique ID
↳ userIdstringID of the associated Vanta user account, if one exists
↳ emailAddressstringThe person's email address
↳ namejsonThe person's name
↳ firststringFirst (given) name
↳ laststringLast (family) name
↳ displaystringDisplay name used in Vanta
↳ employmentjsonThe person's employment information
↳ statusstringEmployment status (UPCOMING, CURRENT, ON_LEAVE, INACTIVE, or FORMER)
↳ startDatestringEmployment start date
↳ endDatestringEmployment end date, if present
↳ jobTitlestringJob title
↳ leaveInfojsonThe person's active or upcoming leave, if any
↳ statusstringLeave status (ACTIVE or UPCOMING)
↳ startDatestringStart of the leave
↳ endDatestringEnd of the leave (null implies indefinite leave)
↳ groupIdsarrayIDs of the groups the person belongs to
↳ tasksSummaryjsonAggregated status of the person's tasks
↳ statusstringOverall task status (e.g., NONE, DUE_SOON, OVERDUE, COMPLETE, PAUSED, or an OFFBOARDING_* variant)
↳ dueDatestringDue date of the person's earliest-due task
↳ completionDatestringDate the person's tasks were completed
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Person

Get a person tracked in Vanta by ID, including employment, leave, and security task status

Inputs and outputs

Input

ParameterTypeRequiredDescription
personIdstringYesUnique ID of the person

Output

ParameterTypeDescription
personjsonThe requested person
↳ idstringThe person's unique ID
↳ userIdstringID of the associated Vanta user account, if one exists
↳ emailAddressstringThe person's email address
↳ namejsonThe person's name
↳ firststringFirst (given) name
↳ laststringLast (family) name
↳ displaystringDisplay name used in Vanta
↳ employmentjsonThe person's employment information
↳ statusstringEmployment status (UPCOMING, CURRENT, ON_LEAVE, INACTIVE, or FORMER)
↳ startDatestringEmployment start date
↳ endDatestringEmployment end date, if present
↳ jobTitlestringJob title
↳ leaveInfojsonThe person's active or upcoming leave, if any
↳ statusstringLeave status (ACTIVE or UPCOMING)
↳ startDatestringStart of the leave
↳ endDatestringEnd of the leave (null implies indefinite leave)
↳ groupIdsarrayIDs of the groups the person belongs to
↳ tasksSummaryjsonAggregated status of the person's tasks
↳ statusstringOverall task status (e.g., NONE, DUE_SOON, OVERDUE, COMPLETE, PAUSED, or an OFFBOARDING_* variant)
↳ dueDatestringDue date of the person's earliest-due task
↳ completionDatestringDate the person's tasks were completed

Vanta List Policies

List the security policies in a Vanta account with approval status and version info

Inputs and outputs

Input

ParameterTypeRequiredDescription
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
policiesarrayPolicies in the Vanta account
↳ idstringThe policy's unique ID
↳ namestringThe policy's name
↳ descriptionstringThe policy's description
↳ statusstringPolicy status (OK or NEEDS_REMEDIATION)
↳ approvedAtDatestringThe policy's most recent approval date, if applicable
↳ latestVersionStatusstringStatus of the policy's latest version (NOT_STARTED, DRAFT, PENDING_APPROVAL, APPROVED, RENEW_SOON, or EXPIRED)
↳ latestApprovedVersionjsonThe latest approved version of the policy, if available
↳ versionIdstringID of the latest approved version
↳ documentsarrayAvailable policy document versions, organized by language
↳ languagestringDocument language
↳ slugIdstringDocument slug ID
↳ urlstringDocument URL
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Policy

Get a Vanta security policy by ID, including its approval status and latest approved version documents

Inputs and outputs

Input

ParameterTypeRequiredDescription
policyIdstringYesUnique ID of the policy

Output

ParameterTypeDescription
policyjsonThe requested policy
↳ idstringThe policy's unique ID
↳ namestringThe policy's name
↳ descriptionstringThe policy's description
↳ statusstringPolicy status (OK or NEEDS_REMEDIATION)
↳ approvedAtDatestringThe policy's most recent approval date, if applicable
↳ latestVersionStatusstringStatus of the policy's latest version (NOT_STARTED, DRAFT, PENDING_APPROVAL, APPROVED, RENEW_SOON, or EXPIRED)
↳ latestApprovedVersionjsonThe latest approved version of the policy, if available
↳ versionIdstringID of the latest approved version
↳ documentsarrayAvailable policy document versions, organized by language
↳ languagestringDocument language
↳ slugIdstringDocument slug ID
↳ urlstringDocument URL

Vanta List Vendors

List the vendors tracked in a Vanta account with risk levels, contract dates, and security review schedules

Inputs and outputs

Input

ParameterTypeRequiredDescription
namestringNoFilter vendors by name
statusMatchesAnystringNoComma-separated vendor statuses to filter by: MANAGED, ARCHIVED, IN_PROCUREMENT
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
vendorsarrayVendors matching the filters
↳ idstringThe vendor's unique ID
↳ namestringThe vendor's display name
↳ statusstringVendor status (MANAGED, ARCHIVED, or IN_PROCUREMENT)
↳ websiteUrlstringThe vendor's website URL
↳ categorystringDisplay name of the vendor's category
↳ servicesProvidedstringServices provided by the vendor
↳ additionalNotesstringAdditional notes about the vendor
↳ accountManagerNamestringThe vendor's external account manager name
↳ accountManagerEmailstringThe vendor's external account manager email
↳ securityOwnerUserIdstringVanta user ID of the vendor's security owner
↳ businessOwnerUserIdstringVanta user ID of the vendor's business owner
↳ inherentRiskLevelstringInherent risk level (CRITICAL, HIGH, MEDIUM, LOW, or UNSCORED)
↳ residualRiskLevelstringResidual risk level (CRITICAL, HIGH, MEDIUM, LOW, or UNSCORED)
↳ isRiskAutoScoredbooleanWhether the vendor's risk is automatically scored
↳ isVisibleToAuditorsbooleanWhether auditors can view this vendor
↳ riskAttributeIdsarrayRisk attribute IDs assigned to the vendor
↳ vendorHeadquartersstringCountry code of the vendor's headquarters
↳ contractStartDatestringDate the vendor contract began
↳ contractRenewalDatestringDate the vendor contract is up for renewal
↳ contractTerminationDatestringDate the vendor contract was terminated
↳ contractAmountjsonContract amount for the vendor
↳ amountnumberAmount of the contract
↳ currencystringCurrency of the contract
↳ nextSecurityReviewDueDatestringNext due date for a security review
↳ lastSecurityReviewCompletionDatestringMost recent date a security review was completed
↳ authDetailsjsonThe vendor's authentication details
↳ methodstringAuthentication method (e.g., SSO, OKTA, USERNAME_PASSWORD)
↳ passwordMFAbooleanWhether passwords require multi-factor authentication
↳ passwordMinimumLengthnumberMinimum password length
↳ passwordRequiresNumberbooleanWhether passwords require a number
↳ passwordRequiresSymbolbooleanWhether passwords require a symbol
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ latestDecisionjsonThe vendor's latest decision (null when no decision has been made)
↳ statusstringDecision status (APPROVED, CONDITIONALLY_APPROVED, or NOT_APPROVED)
↳ lastUpdatedAtstringWhen the decision was last updated
↳ linkedTaskTrackerTaskProcurementRequestjsonLinked task tracker procurement request, if any
↳ urlstringURL of the procurement request
↳ servicestringTask tracker service
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Vendor

Get a Vanta vendor by ID, including risk levels, contract details, and authentication info

Inputs and outputs

Input

ParameterTypeRequiredDescription
vendorIdstringYesUnique ID of the vendor

Output

ParameterTypeDescription
vendorjsonThe requested vendor
↳ idstringThe vendor's unique ID
↳ namestringThe vendor's display name
↳ statusstringVendor status (MANAGED, ARCHIVED, or IN_PROCUREMENT)
↳ websiteUrlstringThe vendor's website URL
↳ categorystringDisplay name of the vendor's category
↳ servicesProvidedstringServices provided by the vendor
↳ additionalNotesstringAdditional notes about the vendor
↳ accountManagerNamestringThe vendor's external account manager name
↳ accountManagerEmailstringThe vendor's external account manager email
↳ securityOwnerUserIdstringVanta user ID of the vendor's security owner
↳ businessOwnerUserIdstringVanta user ID of the vendor's business owner
↳ inherentRiskLevelstringInherent risk level (CRITICAL, HIGH, MEDIUM, LOW, or UNSCORED)
↳ residualRiskLevelstringResidual risk level (CRITICAL, HIGH, MEDIUM, LOW, or UNSCORED)
↳ isRiskAutoScoredbooleanWhether the vendor's risk is automatically scored
↳ isVisibleToAuditorsbooleanWhether auditors can view this vendor
↳ riskAttributeIdsarrayRisk attribute IDs assigned to the vendor
↳ vendorHeadquartersstringCountry code of the vendor's headquarters
↳ contractStartDatestringDate the vendor contract began
↳ contractRenewalDatestringDate the vendor contract is up for renewal
↳ contractTerminationDatestringDate the vendor contract was terminated
↳ contractAmountjsonContract amount for the vendor
↳ amountnumberAmount of the contract
↳ currencystringCurrency of the contract
↳ nextSecurityReviewDueDatestringNext due date for a security review
↳ lastSecurityReviewCompletionDatestringMost recent date a security review was completed
↳ authDetailsjsonThe vendor's authentication details
↳ methodstringAuthentication method (e.g., SSO, OKTA, USERNAME_PASSWORD)
↳ passwordMFAbooleanWhether passwords require multi-factor authentication
↳ passwordMinimumLengthnumberMinimum password length
↳ passwordRequiresNumberbooleanWhether passwords require a number
↳ passwordRequiresSymbolbooleanWhether passwords require a symbol
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ latestDecisionjsonThe vendor's latest decision (null when no decision has been made)
↳ statusstringDecision status (APPROVED, CONDITIONALLY_APPROVED, or NOT_APPROVED)
↳ lastUpdatedAtstringWhen the decision was last updated
↳ linkedTaskTrackerTaskProcurementRequestjsonLinked task tracker procurement request, if any
↳ urlstringURL of the procurement request
↳ servicestringTask tracker service

Vanta List Monitored Computers

List the monitored computers in a Vanta account with screenlock, disk encryption, password manager, and antivirus check outcomes

Inputs and outputs

Input

ParameterTypeRequiredDescription
complianceStatusFilterMatchesAnystringNoComma-separated compliance issues to filter by: PWM_NOT_INSTALLED, HD_NOT_ENCRYPTED, AV_NOT_INSTALLED, SCREENLOCK_NOT_CONFIGURED, LAST_CHECK_OVER_14_DAYS
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
computersarrayMonitored computers matching the filters
↳ idstringUnique identifier of the monitored computer
↳ integrationIdstringIntegration that reports this computer
↳ lastCheckDatestringDate of the computer's most recent report
↳ screenlockstringScreenlock check outcome (PASS, FAIL, IN_PROGRESS, or NA)
↳ diskEncryptionstringDisk encryption check outcome (PASS, FAIL, IN_PROGRESS, or NA)
↳ passwordManagerstringPassword manager check outcome (PASS, FAIL, IN_PROGRESS, or NA)
↳ antivirusInstallationstringAntivirus check outcome (PASS, FAIL, IN_PROGRESS, or NA)
↳ operatingSystemjsonThe computer's operating system
↳ typestringOperating system type (macOS, linux, or windows)
↳ versionstringOperating system version
↳ ownerjsonThe computer's owner
↳ idstringUnique ID of the owner
↳ displayNamestringDisplay name of the owner
↳ emailAddressstringEmail address of the owner
↳ serialNumberstringSerial number of the computer
↳ udidstringUniversal device ID of the computer
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Vulnerabilities

List the vulnerabilities detected across a Vanta account with filters for severity, fixability, SLA deadlines, package, and integration

Inputs and outputs

Input

ParameterTypeRequiredDescription
qstringNoSearch query for vulnerabilities
severitystringNoFilter by severity: LOW, MEDIUM, HIGH, or CRITICAL
isFixAvailablebooleanNoFilter by whether a fix is available
isDeactivatedbooleanNoFilter by whether vulnerability monitoring is deactivated
includeVulnerabilitiesWithoutSlasbooleanNoInclude vulnerabilities that have no SLA deadline
packageIdentifierstringNoFilter by the affected package identifier
externalVulnerabilityIdstringNoFilter by external vulnerability ID (e.g., a CVE identifier)
integrationIdstringNoFilter by the integration that detected the vulnerability
vulnerableAssetIdstringNoFilter by the vulnerable asset ID
slaDeadlineAfterDatestringNoOnly include vulnerabilities with an SLA deadline after this ISO 8601 date
slaDeadlineBeforeDatestringNoOnly include vulnerabilities with an SLA deadline before this ISO 8601 date
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
vulnerabilitiesarrayVulnerabilities matching the filters
↳ idstringUnique identifier of the vulnerability
↳ namestringDisplay name of the vulnerability
↳ descriptionstringDescription of the vulnerability
↳ severitystringSeverity (LOW, MEDIUM, HIGH, or CRITICAL)
↳ vulnerabilityTypestringVulnerability type (CONFIGURATION, COMMON, or GROUPED)
↳ integrationIdstringIntegration that scans this vulnerability
↳ targetIdstringID of the resource the vulnerability was found on
↳ packageIdentifierstringIdentifier of the affected package (COMMON and GROUPED vulnerabilities only)
↳ cvssSeverityScorenumberCVSS severity score
↳ scannerScorenumberScanner score
↳ isFixablebooleanWhether the vulnerability is fixable
↳ fixedVersionstringPackage version that remediates the vulnerability
↳ remediateByDatestringSLA date by which the vulnerability should be remediated
↳ firstDetectedDatestringDate first detected by Vanta
↳ sourceDetectedDatestringDate first detected by the source
↳ lastDetectedDatestringDate last detected
↳ scanSourcestringScanning tool that detected the vulnerability
↳ externalURLstringExternal URL for the vulnerability
↳ relatedVulnsarrayRelated vulnerabilities (GROUPED vulnerabilities only)
↳ relatedUrlsarrayRelated URLs
↳ deactivateMetadatajsonDeactivation metadata, if the vulnerability was deactivated
↳ isVulnDeactivatedIndefinitelybooleanWhether deactivated indefinitely
↳ deactivatedUntilDatestringDate the vulnerability will be reactivated
↳ deactivationReasonstringReason for deactivation
↳ deactivatedOnDatestringDate the vulnerability was deactivated
↳ deactivatedBystringUser who deactivated the vulnerability
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Vulnerability Remediations

List remediated vulnerabilities in a Vanta account with detection, SLA deadline, and remediation dates

Inputs and outputs

Input

ParameterTypeRequiredDescription
integrationIdstringNoFilter by the integration that detected the vulnerability
severitystringNoFilter by severity: LOW, MEDIUM, HIGH, or CRITICAL
isRemediatedOnTimebooleanNoFilter by whether the vulnerability was remediated before its SLA deadline
remediatedAfterDatestringNoOnly include remediations completed after this ISO 8601 date
remediatedBeforeDatestringNoOnly include remediations completed before this ISO 8601 date
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
remediationsarrayVulnerability remediations matching the filters
↳ idstringUnique identifier of the remediation
↳ vulnerabilityIdstringID of the remediated vulnerability
↳ vulnerableAssetIdstringID of the vulnerable asset
↳ severitystringSeverity of the vulnerability
↳ detectedDatestringDate the vulnerability was first detected
↳ slaDeadlineDatestringSLA deadline for remediation
↳ remediationDatestringDate the vulnerability was remediated
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta List Vulnerable Assets

List the assets associated with vulnerabilities in a Vanta account (servers, repositories, workstations, and more)

Inputs and outputs

Input

ParameterTypeRequiredDescription
qstringNoSearch query for vulnerable assets
integrationIdstringNoFilter by the integration scanning the asset
assetTypestringNoFilter by asset type: SERVER, SERVERLESS_FUNCTION, CONTAINER, CONTAINER_REPOSITORY, CONTAINER_REPOSITORY_IMAGE, CODE_REPOSITORY, MANIFEST_FILE, WORKSTATION, or OTHER
assetExternalAccountIdstringNoFilter by the external account ID the asset belongs to
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
assetsarrayVulnerable assets matching the filters
↳ idstringUnique identifier of the vulnerable asset
↳ namestringDisplay name of the vulnerable asset
↳ assetTypestringAsset type (e.g., SERVER, SERVERLESS_FUNCTION, CONTAINER_REPOSITORY, CODE_REPOSITORY, WORKSTATION)
↳ hasBeenScannedbooleanWhether the asset has been scanned
↳ imageScanTagstringContainer image tag that vulnerabilities are retrieved for (container repositories only)
↳ scannersarrayIntegrations scanning this asset, with per-scanner asset details (resource ID, hostnames, IPs, image metadata)
↳ resourceIdstringVanta resource ID
↳ integrationIdstringScanning integration ID
↳ targetIdstringAsset identifier in the scanning source
↳ imageDigeststringContainer image digest
↳ imagePushedAtDatestringContainer image push date
↳ parentAccountOrOrganizationstringParent account or organization
↳ biosUuidstringBIOS UUID
↳ imageTagsarrayContainer image tags
↳ ipv4sarrayIPv4 addresses
↳ ipv6sarrayIPv6 addresses
↳ macAddressesarrayMAC addresses
↳ hostnamesarrayHost names
↳ fqdnsarrayFully qualified domain names
↳ operatingSystemsarrayOperating systems
↳ assetTagsarrayTags from the scanning source
↳ keystringTag key
↳ valuestringTag value
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Vulnerable Asset

Get a vulnerable asset in Vanta by ID, including the scanners reporting it and per-scanner asset details

Inputs and outputs

Input

ParameterTypeRequiredDescription
vulnerableAssetIdstringYesUnique ID of the vulnerable asset

Output

ParameterTypeDescription
assetjsonThe requested vulnerable asset
↳ idstringUnique identifier of the vulnerable asset
↳ namestringDisplay name of the vulnerable asset
↳ assetTypestringAsset type (e.g., SERVER, SERVERLESS_FUNCTION, CONTAINER_REPOSITORY, CODE_REPOSITORY, WORKSTATION)
↳ hasBeenScannedbooleanWhether the asset has been scanned
↳ imageScanTagstringContainer image tag that vulnerabilities are retrieved for (container repositories only)
↳ scannersarrayIntegrations scanning this asset, with per-scanner asset details (resource ID, hostnames, IPs, image metadata)
↳ resourceIdstringVanta resource ID
↳ integrationIdstringScanning integration ID
↳ targetIdstringAsset identifier in the scanning source
↳ imageDigeststringContainer image digest
↳ imagePushedAtDatestringContainer image push date
↳ parentAccountOrOrganizationstringParent account or organization
↳ biosUuidstringBIOS UUID
↳ imageTagsarrayContainer image tags
↳ ipv4sarrayIPv4 addresses
↳ ipv6sarrayIPv6 addresses
↳ macAddressesarrayMAC addresses
↳ hostnamesarrayHost names
↳ fqdnsarrayFully qualified domain names
↳ operatingSystemsarrayOperating systems
↳ assetTagsarrayTags from the scanning source
↳ keystringTag key
↳ valuestringTag value

Vanta List Risk Scenarios

List the risk scenarios in a Vanta risk register with likelihood/impact scores, treatment decisions, and review status

Inputs and outputs

Input

ParameterTypeRequiredDescription
searchStringstringNoSearch string to filter risk scenarios
includeIgnoredbooleanNoInclude ignored risk scenarios
typestringNoFilter by scenario type: "Risk Scenario" or "Enterprise Risk"
ownerMatchesAnystringNoComma-separated owner emails to filter by
categoryMatchesAnystringNoComma-separated risk categories to filter by
ciaCategoryMatchesAnystringNoComma-separated CIA categories to filter by: Confidentiality, Integrity, Availability
treatmentTypeMatchesAnystringNoComma-separated treatments to filter by: Mitigate, Transfer, Avoid, Accept
inherentScoreGroupMatchesAnystringNoComma-separated inherent score groups to filter by: "Very low", Low, Med, High, Critical
residualScoreGroupMatchesAnystringNoComma-separated residual score groups to filter by: "Very low", Low, Med, High, Critical
reviewStatusMatchesAnystringNoComma-separated review statuses to filter by: APPROVED, DRAFT, NOT_REVIEWED, AWAITING_SUBMISSION, PENDING_APPROVAL, REQUESTED_CHANGES
orderBystringNoField to order results by: description or createdAt
pageSizenumberNoMaximum number of items per page (1-100, default 10)
pageCursorstringNoPagination cursor: pass the endCursor from the previous response to fetch the next page

Output

ParameterTypeDescription
riskScenariosarrayRisk scenarios matching the filters
↳ riskIdstringUnique user-specified ID of the risk scenario
↳ descriptionstringDescription of the risk scenario
↳ likelihoodnumberLikelihood score (defaults to a 1-5 range; null when unscored)
↳ impactnumberImpact score (defaults to a 1-5 range; null when unscored)
↳ residualLikelihoodnumberResidual likelihood score after treatments
↳ residualImpactnumberResidual impact score after treatments
↳ categoriesarrayCategories this risk scenario belongs to
↳ ciaCategoriesarrayCIA categories (Confidentiality, Integrity, Availability)
↳ treatmentstringRisk treatment decision (Mitigate, Transfer, Avoid, or Accept)
↳ ownerstringEmail of the person responsible for this risk
↳ notestringAdditional context about the risk scenario
↳ riskRegisterstringName of the associated risk register
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ isArchivedbooleanWhether the scenario is archived
↳ reviewStatusstringReview status (APPROVED, DRAFT, NOT_REVIEWED, AWAITING_SUBMISSION, PENDING_APPROVAL, or REQUESTED_CHANGES)
↳ requiredApproversarrayRequired approvers for this risk scenario
↳ typestringScenario type ("Risk Scenario" or "Enterprise Risk")
↳ identificationDatestringDate this risk was identified
pageInfojsonCursor pagination info for the returned page; pass endCursor as pageCursor to fetch the next page
↳ startCursorstringCursor pointing to the start of the current page
↳ endCursorstringCursor pointing to the end of the current page; pass as pageCursor to fetch the next page
↳ hasNextPagebooleanWhether another page exists after this one
↳ hasPreviousPagebooleanWhether a page exists before this one

Vanta Get Risk Scenario

Get a Vanta risk scenario by ID, including its scores, treatment decision, and review status

Inputs and outputs

Input

ParameterTypeRequiredDescription
riskScenarioIdstringYesUnique ID of the risk scenario

Output

ParameterTypeDescription
riskScenariojsonThe requested risk scenario
↳ riskIdstringUnique user-specified ID of the risk scenario
↳ descriptionstringDescription of the risk scenario
↳ likelihoodnumberLikelihood score (defaults to a 1-5 range; null when unscored)
↳ impactnumberImpact score (defaults to a 1-5 range; null when unscored)
↳ residualLikelihoodnumberResidual likelihood score after treatments
↳ residualImpactnumberResidual impact score after treatments
↳ categoriesarrayCategories this risk scenario belongs to
↳ ciaCategoriesarrayCIA categories (Confidentiality, Integrity, Availability)
↳ treatmentstringRisk treatment decision (Mitigate, Transfer, Avoid, or Accept)
↳ ownerstringEmail of the person responsible for this risk
↳ notestringAdditional context about the risk scenario
↳ riskRegisterstringName of the associated risk register
↳ customFieldsarrayCustom field values configured in the Vanta instance
↳ labelstringCustom field label
↳ valuejsonCustom field value (string or list of strings)
↳ isArchivedbooleanWhether the scenario is archived
↳ reviewStatusstringReview status (APPROVED, DRAFT, NOT_REVIEWED, AWAITING_SUBMISSION, PENDING_APPROVAL, or REQUESTED_CHANGES)
↳ requiredApproversarrayRequired approvers for this risk scenario
↳ typestringScenario type ("Risk Scenario" or "Enterprise Risk")
↳ identificationDatestringDate this risk was identified
Was this helpful?
Suggest an edit