Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HashiCorp Vault Auth API

Auth method management

HashiCorp Vault Auth API is one of 28 APIs that HashiCorp Vault publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auth. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://vault.example.com/v1.

3 operations 2 paths 1 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://vault.example.com/v1/sys
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HashiCorp Vault Auth API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Vault-Token (vaultToken). By default, every request must be authenticated.

  • vaultToken — Vault authentication token

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 3

Auth method management

GET
/sys/auth
HashiCorp Vault List auth methods
listAuthMethods → 200403
POST
/sys/auth/{path}
HashiCorp Vault Enable auth method
enableAuthMethod 1 param body → 204400403
DELETE
/sys/auth/{path}
HashiCorp Vault Disable auth method
disableAuthMethod 1 param → 204403

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AuthMount (8 properties). Each schema is shown below with its type and property counts.

AuthMount
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hvault-auth-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

HashiCorp Vault AppRole API
HashiCorp Vault Audit API
HashiCorp Vault AWS API
HashiCorp Vault Configuration API
HashiCorp Vault Database API
HashiCorp Vault Entity Alias API
HashiCorp Vault Entity API
HashiCorp Vault GitHub API
HashiCorp Vault Group Alias API
HashiCorp Vault Group API
HashiCorp Vault Health API
HashiCorp Vault Init API