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

The Auth API from HashiCorp — 17 operation(s) for auth.

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

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

This API exposes 21 operations across 17 paths. It is described by OpenAPI 3.0.2, at version 1.9.3.

21 operations 17 paths 0 schemas 1 DELETE5 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.9.3
Resource Areas
1

Paths & Operations 21

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

Auth 21
GET
/auth/token/accessors/
HashiCorp List token accessors, which can then be be used to iterate and discover their properties or revoke them. Because this can be used to cause a denial of service, this endpoint requires 'sudo'…
getAuthTokenAccessors 1 param → 200
POST
/auth/token/create
HashiCorp The token create path is used to create new tokens.
postAuthTokenCreate → 200
POST
/auth/token/create-orphan
HashiCorp The token create path is used to create new orphan tokens.
postAuthTokenCreateOrphan → 200
POST
/auth/token/create/{role_name}
HashiCorp This token create path is used to create new tokens adhering to the given role.
postAuthTokenCreateRole_name 1 param → 200
GET
/auth/token/lookup
HashiCorp This endpoint will lookup a token and its properties.
getAuthTokenLookup → 200
POST
/auth/token/lookup
HashiCorp This endpoint will lookup a token and its properties.
postAuthTokenLookup body → 200
POST
/auth/token/lookup-accessor
HashiCorp This endpoint will lookup a token associated with the given accessor and its properties. Response will not contain the token ID.
postAuthTokenLookupAccessor body → 200
GET
/auth/token/lookup-self
HashiCorp This endpoint will lookup a token and its properties.
getAuthTokenLookupSelf → 200
POST
/auth/token/lookup-self
HashiCorp This endpoint will lookup a token and its properties.
postAuthTokenLookupSelf body → 200
POST
/auth/token/renew
HashiCorp This endpoint will renew the given token and prevent expiration.
postAuthTokenRenew body → 200
POST
/auth/token/renew-accessor
HashiCorp This endpoint will renew a token associated with the given accessor and its properties. Response will not contain the token ID.
postAuthTokenRenewAccessor body → 200
POST
/auth/token/renew-self
HashiCorp This endpoint will renew the token used to call it and prevent expiration.
postAuthTokenRenewSelf body → 200
POST
/auth/token/revoke
HashiCorp This endpoint will delete the given token and all of its child tokens.
postAuthTokenRevoke body → 200
POST
/auth/token/revoke-accessor
HashiCorp This endpoint will delete the token associated with the accessor and all of its child tokens.
postAuthTokenRevokeAccessor body → 200
POST
/auth/token/revoke-orphan
HashiCorp This endpoint will delete the token and orphan its child tokens.
postAuthTokenRevokeOrphan body → 200
POST
/auth/token/revoke-self
HashiCorp This endpoint will delete the token used to call it and all of its child tokens.
postAuthTokenRevokeSelf → 200
GET
/auth/token/roles
HashiCorp This endpoint lists configured roles.
getAuthTokenRoles 1 param → 200
GET
/auth/token/roles/{role_name}
getAuthTokenRolesRole_name 1 param → 200
POST
/auth/token/roles/{role_name}
postAuthTokenRolesRole_name 1 param body → 200
DELETE
/auth/token/roles/{role_name}
deleteAuthTokenRolesRole_name 1 param → 204
POST
/auth/token/tidy
HashiCorp This endpoint performs cleanup tasks that can be run if certain error conditions have occurred.
postAuthTokenTidy → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-auth-api-openapi.yml Raw ↑

Other APIs HashiCorp publishes across the network.

HashiCorp Terraform
HashiCorp Nomad
HashiCorp Consul
HashiCorp Boundary
HashiCorp Vagrant
HashiCorp Identity API
HashiCorp Secrets API
HashiCorp System API