Contact Us
Help Center Home > Vault > Vault: Access API Documentation

Vault: Access API Documentation

Vault provides a Swagger interface containing comprehensive documentation of our APIs. This allows you to integrate third-party solutions with Vault or automate specific processes and services.

Follow the steps below to access the API documentation.

Prerequisites

  • A dedicated API user which is necessary for authentication and authorization of API calls

Creating an API user

  1. Go to Administration > Users to create an API user.
  2. Activate the API user by clicking the confirmation link sent to the user’s email address.

Note:

API Users are restricted to API authentication and cannot access the PAM web console or platform. Any attempt to log in to the web console will result in an error.

Accessing the Vault API

  1. Open your browser and navigate to the URL of your Vault environment.

Note:

You can access the respective Swagger documentation by adding .api to their platform URL. For example, https://acmecompany.api.vault.jumpcloud.com, where acmecompany is the name of the customer.

  1. Enter the following information:
    • Vault Name: Enter your company name.
    • User name or email: Enter your email Id.
    • Password: Enter your password.
    • Optional: select Stay signed in
  1. Click Log in.
  2. You will be redirected to the Vault interface after successful authentication.
  3. Once logged in, select Swagger UI.
  4. You’ll be redirected to the Swagger page where you can explore all available API endpoints, see request and response formats, and even test calls directly.
Back to Top

List IconIn this Article

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case