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 API

Identity entity management

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

This API exposes 10 operations across 5 paths, and defines 3 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.

10 operations 5 paths 3 schemas 2 DELETE3 GET5 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 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 10

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

Entity 10

Identity entity management

POST
/identity/entity
HashiCorp Vault Create entity
createEntity body → 200400403
GET
/identity/entity
HashiCorp Vault List entities
listEntities → 200403
GET
/identity/entity/id/{id}
HashiCorp Vault Read entity by ID
readEntityById 1 param → 200403404
POST
/identity/entity/id/{id}
HashiCorp Vault Update entity by ID
updateEntityById 1 param body → 200400403
DELETE
/identity/entity/id/{id}
HashiCorp Vault Delete entity by ID
deleteEntityById 1 param → 204403
GET
/identity/entity/name/{name}
HashiCorp Vault Read entity by name
readEntityByName 1 param → 200404
POST
/identity/entity/name/{name}
HashiCorp Vault Update entity by name
updateEntityByName 1 param body → 200400
DELETE
/identity/entity/name/{name}
HashiCorp Vault Delete entity by name
deleteEntityByName 1 param → 204
POST
/identity/entity/batch-delete
HashiCorp Vault Batch delete entities
batchDeleteEntities body → 204403
POST
/identity/entity/merge
HashiCorp Vault Merge entities
mergeEntities body → 204400403

Schemas 3

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

EntityRequest
object
4 properties
EntityAlias
object
9 properties
Entity
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hvault-entity-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 Alias API
HashiCorp Vault GitHub API
HashiCorp Vault Group Alias API
HashiCorp Vault Group API
HashiCorp Vault Health API
HashiCorp Vault Init API