> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ruby.ad/llms.txt
> Use this file to discover all available pages before exploring further.

# Vanta

## Use Case Examples

> [card] Security Tests & Monitoring
>
> List and filter automated security tests, view test status, and identify failing resources across your infrastructure.

> [card] Controls & Frameworks
>
> Access security controls, map them to compliance frameworks, and review implementation status.

> [card] Compliance Documentation
>
> Retrieve compliance documents, evidence, and their associated controls for audit preparation.

> [card] Vulnerability Management
>
> Query vulnerabilities by severity, CVE ID, affected assets, and SLA deadlines to prioritize remediation efforts.

> [card] Risk Register
>
> Review risk scenarios, their scoring, treatment status, and mitigation strategies.

> [card] Integration Status
>
> Check connected integrations and monitor their health to ensure continuous compliance monitoring.

## Admin Setup

This integration requires **read-only** access to your Vanta account facilitated via an OAuth Application.

### Creating a New Vanta Application

See the official [Vanta API Access Setup Guide](https://developer.vanta.com/docs/api-access-setup#authentication-and-token-retrieval).

1. Login to Vanta and navigate to the "Settings" page > then "Developer Console" and then click "Create":
2. Give your application a name & description and then select the `Manage Vanta` App type.
3. You will see that the OAuth client ID and secret was autogenerated.

\*\*Note: \*\*Only share these two values with trusted team members, as these can be used together to authenticate to the Vanta API. You can always regenerate a new client secret if you want to rotate credentials for security reasons. Ruby will only request the `vanta-api.all:read` scope using these tokens. This will provide Ruby with read access to all the "Manage Vanta" endpoints specified [here](https://developer.vanta.com/docs/api-access-setup).

### Setup in Ruby

The tool uses workspace-level credentials, meaning the authentication credentials you provide during setup will be shared by all users in the workspace with access to these tools.

1. Go to Spaces > Tools in your Ruby workspace, click Add Tools, and select Vanta.
2. Provide the client ID and client secret in the configuration form.

## Available Tools

| **Name** | **Description** |
| :- | :- |
| List Tests | List Vanta's automated security and compliance tests with optional filtering by status, category, framework, or integration. |
| List Test Entities | Get the resources monitored by a specific security test. Filter by status using FAILING or DEACTIVATED to identify resources requiring attention. |
| List Controls | List security controls in your Vanta account or retrieve a specific control by ID with framework mapping details. Supports filtering by framework ID. |
| List Control Tests | Enumerate automated tests that validate a specific security control, including status and failing entity information. |
| List Control Documents | List documents mapped to a control to locate supporting evidence quickly. |
| List Documents | List compliance documents in your Vanta account or retrieve a specific document by ID. |
| List Document Resources | Retrieve resources linked to a document (controls, links, uploads) by choosing the desired resource type. |
| List Integrations | List integrations connected to your Vanta account or retrieve details for a specific integration. |
| List Frameworks | List compliance frameworks in your Vanta account with completion status and progress metrics. |
| List Framework Controls | Retrieve the controls associated with a compliance framework, including descriptions and implementation guidance. |
| List People | List people in your Vanta account or retrieve a specific person by ID with role and group membership. |
| List Risks | List risk scenarios in your risk register or retrieve a specific scenario to review status, scoring, and treatment. |
| List Vulnerabilities | List vulnerabilities detected across your infrastructure with CVE details, severity, and impacted assets. |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.