REST API Reference Download

Overview

The Verify Privilege Vault REST API guides are version specific. In fact, they are automatically generated when a Verify Privilege Vault version is created. Thus, to ensure you have the correct guides for your Verify Privilege Vault version, it is best (but not required) to access the documentation from that version of Verify Privilege Vault; however there are many reasons why this might not be practical, so we provide download links below.

Accessing the Guides

To access the guides:

  1. For Verify Privilege Vault click the question mark icon in the top right of the dashboard and click REST API Guide. The Verify Privilege Vault REST API Guide page appears.

  2. Accessing Verify Privilege Vault through the API and scripts can be powerful mechanism but ensure you are following best practices with the account and access for any script connecting to Verify Privilege Vault. The Verify Privilege Vault Software Development Kit for DevOps is recommended for all automated or machine-to-machine scripts. If not using the SDK, creating an application account for the script access and limiting the permissions both from Role perspective and on Secret themselves is security best practice.

  3. On the Verify Privilege Vault REST API page of your instance, choose one of the three guides:

    • Bearer token authentication: Hyperlinked documentation for REST API access using token authentication.
    • Token authentication: Instructions for getting an authentication token.
    • Windows Integrated Authentication: Hyperlinked documentation for REST API access using Integrated Windows Authentication (IWA).

Downloading the Guides

Only use the following links if you cannot easily access a guide from a version of Verify Privilege Vault. There is a possibility the guides below are not the most current versions.

Current Version

Current Verify Privilege Vault REST API Guide

Version Archive