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

AppRole auth method

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

Tagged areas include Auth - AppRole. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.15.0.

Requests are made against 2 base URLs: https://127.0.0.1:8200/v1, https://{vault_host}:{port}/v1.

1 operations 1 paths 1 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.15.0
Base URL
https://127.0.0.1:8200/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

HashiCorp Vault Auth - AppRole 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 client token

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Auth - AppRole 1

AppRole auth method

POST
/auth/approle/login
Login with AppRole
loginAppRole body → 200

Schemas 1

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

VaultResponse
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-vault-auth-approle-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

HashiCorp Vault Auth - Token API
HashiCorp Vault Auth - Userpass API
HashiCorp Vault Identity API
HashiCorp Vault Leases API
HashiCorp Vault Policy API
HashiCorp Vault Secrets - KV v2 API
HashiCorp Vault Secrets - Transit API
HashiCorp Vault System API