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 Methods API

Enable, disable, list, and configure authentication methods.

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

This API exposes 5 JSON Schema definitions.

Tagged areas include Auth Methods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

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

3 operations 2 paths 4 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://vault.example.com/v1
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

HashiCorp Vault Auth Methods 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 token for authenticating API requests. Tokens can be created via login endpoints or the token auth method. The token must have appropriate policy permiss…

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 Methods 3

Enable, disable, list, and configure authentication methods.

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 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AuthMethodConfig (3 properties), EnableAuthMethodRequest (2 properties), AuthMethodsResponse (1 property), VaultError (1 property). Each schema is shown below with its type and property counts.

EnableAuthMethodRequest
object
2 properties 1 required
AuthMethodConfig
object
3 properties
VaultError
object
1 property
AuthMethodsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vault-auth-methods-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

Vault HTTP API
HashiCorp Vault Health API
HashiCorp Vault Leases API
HashiCorp Vault Policies API
HashiCorp Vault Secrets Config API
HashiCorp Vault Secrets Data API
HashiCorp Vault Secrets Engines API
HashiCorp Vault Secrets Metadata API