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 Entity Alias API

Identity entity alias management

HashiCorp Vault Entity Alias 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 Entity Alias. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 2 schemas. 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.

4 operations 2 paths 2 schemas 1 DELETE1 GET2 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 Entity Alias 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 4

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

Entity Alias 4

Identity entity alias management

POST
/identity/entity-alias
HashiCorp Vault Create entity alias
createEntityAlias body → 200400403
GET
/identity/entity-alias/id/{id}
HashiCorp Vault Read entity alias
readEntityAlias 1 param → 200404
POST
/identity/entity-alias/id/{id}
HashiCorp Vault Update entity alias
updateEntityAlias 1 param body → 200400
DELETE
/identity/entity-alias/id/{id}
HashiCorp Vault Delete entity alias
deleteEntityAlias 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are EntityAlias (9 properties), EntityAliasRequest (4 properties). Each schema is shown below with its type and property counts.

EntityAliasRequest
object
4 properties 3 required
EntityAlias
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hvault-entity-alias-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

HashiCorp Vault AppRole API
HashiCorp Vault Audit API
HashiCorp Vault Auth API
HashiCorp Vault AWS API
HashiCorp Vault Configuration API
HashiCorp Vault Database 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