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

Identity group management

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

This API exposes 8 operations across 3 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.

8 operations 3 paths 3 schemas 2 DELETE3 GET3 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 Group 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 8

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

Group 8

Identity group management

POST
/identity/group
HashiCorp Vault Create group
createGroup body → 200400403
GET
/identity/group
HashiCorp Vault List groups
listGroups → 200403
GET
/identity/group/id/{id}
HashiCorp Vault Read group by ID
readGroupById 1 param → 200404
POST
/identity/group/id/{id}
HashiCorp Vault Update group by ID
updateGroupById 1 param body → 200400
DELETE
/identity/group/id/{id}
HashiCorp Vault Delete group by ID
deleteGroupById 1 param → 204
GET
/identity/group/name/{name}
HashiCorp Vault Read group by name
readGroupByName 1 param → 200404
POST
/identity/group/name/{name}
HashiCorp Vault Update group by name
updateGroupByName 1 param body → 200400
DELETE
/identity/group/name/{name}
HashiCorp Vault Delete group by name
deleteGroupByName 1 param → 204

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Group (11 properties), GroupAlias (8 properties), GroupRequest (6 properties). Each schema is shown below with its type and property counts.

GroupRequest
object
6 properties
GroupAlias
object
8 properties
Group
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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