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

The Identity API from HashiCorp — 49 operation(s) for identity.

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

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

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

80 operations 49 paths 0 schemas 14 DELETE36 GET30 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 80

Across 49 paths, the API surfaces 80 operations — 14 DELETE, 36 GET, 30 POST. Each is listed below with its method, path, parameters, and response codes.

Identity 80
POST
/identity/alias
HashiCorp Create a new alias.
postIdentityAlias body → 200
GET
/identity/alias/id
HashiCorp List all the alias IDs.
getIdentityAliasId 1 param → 200
GET
/identity/alias/id/{id}
HashiCorp Update, read or delete an alias ID.
getIdentityAliasIdId 1 param → 200
POST
/identity/alias/id/{id}
HashiCorp Update, read or delete an alias ID.
postIdentityAliasIdId 1 param body → 200
DELETE
/identity/alias/id/{id}
HashiCorp Update, read or delete an alias ID.
deleteIdentityAliasIdId 1 param → 204
POST
/identity/entity
HashiCorp Create a new entity
postIdentityEntity body → 200
POST
/identity/entity-alias
HashiCorp Create a new alias.
postIdentityEntityAlias body → 200
GET
/identity/entity-alias/id
HashiCorp List all the alias IDs.
getIdentityEntityAliasId 1 param → 200
GET
/identity/entity-alias/id/{id}
HashiCorp Update, read or delete an alias ID.
getIdentityEntityAliasIdId 1 param → 200
POST
/identity/entity-alias/id/{id}
HashiCorp Update, read or delete an alias ID.
postIdentityEntityAliasIdId 1 param body → 200
DELETE
/identity/entity-alias/id/{id}
HashiCorp Update, read or delete an alias ID.
deleteIdentityEntityAliasIdId 1 param → 204
POST
/identity/entity/batch-delete
HashiCorp Delete all of the entities provided
postIdentityEntityBatchDelete body → 200
GET
/identity/entity/id
HashiCorp List all the entity IDs
getIdentityEntityId 1 param → 200
GET
/identity/entity/id/{id}
HashiCorp Update, read or delete an entity using entity ID
getIdentityEntityIdId 1 param → 200
POST
/identity/entity/id/{id}
HashiCorp Update, read or delete an entity using entity ID
postIdentityEntityIdId 1 param body → 200
DELETE
/identity/entity/id/{id}
HashiCorp Update, read or delete an entity using entity ID
deleteIdentityEntityIdId 1 param → 204
POST
/identity/entity/merge
HashiCorp Merge two or more entities together
postIdentityEntityMerge body → 200
GET
/identity/entity/name
HashiCorp List all the entity names
getIdentityEntityName 1 param → 200
GET
/identity/entity/name/{name}
HashiCorp Update, read or delete an entity using entity name
getIdentityEntityNameName 1 param → 200
POST
/identity/entity/name/{name}
HashiCorp Update, read or delete an entity using entity name
postIdentityEntityNameName 1 param body → 200
DELETE
/identity/entity/name/{name}
HashiCorp Update, read or delete an entity using entity name
deleteIdentityEntityNameName 1 param → 204
POST
/identity/group
HashiCorp Create a new group.
postIdentityGroup body → 200
POST
/identity/group-alias
HashiCorp Creates a new group alias, or updates an existing one.
postIdentityGroupAlias body → 200
GET
/identity/group-alias/id
HashiCorp List all the group alias IDs.
getIdentityGroupAliasId 1 param → 200
GET
/identity/group-alias/id/{id}
getIdentityGroupAliasIdId 1 param → 200
POST
/identity/group-alias/id/{id}
postIdentityGroupAliasIdId 1 param body → 200
DELETE
/identity/group-alias/id/{id}
deleteIdentityGroupAliasIdId 1 param → 204
GET
/identity/group/id
HashiCorp List all the group IDs.
getIdentityGroupId 1 param → 200
GET
/identity/group/id/{id}
HashiCorp Update or delete an existing group using its ID.
getIdentityGroupIdId 1 param → 200
POST
/identity/group/id/{id}
HashiCorp Update or delete an existing group using its ID.
postIdentityGroupIdId 1 param body → 200
DELETE
/identity/group/id/{id}
HashiCorp Update or delete an existing group using its ID.
deleteIdentityGroupIdId 1 param → 204
GET
/identity/group/name
getIdentityGroupName 1 param → 200
GET
/identity/group/name/{name}
getIdentityGroupNameName 1 param → 200
POST
/identity/group/name/{name}
postIdentityGroupNameName 1 param body → 200
DELETE
/identity/group/name/{name}
deleteIdentityGroupNameName 1 param → 204
POST
/identity/lookup/entity
HashiCorp Query entities based on various properties.
postIdentityLookupEntity body → 200
POST
/identity/lookup/group
HashiCorp Query groups based on various properties.
postIdentityLookupGroup body → 200
GET
/identity/oidc/.well-known/keys
HashiCorp Retrieve public keys
getIdentityOidcWellKnownKeys → 200
GET
/identity/oidc/.well-known/openid-configuration
HashiCorp Query OIDC configurations
getIdentityOidcWellKnownOpenidConfiguration → 200
GET
/identity/oidc/assignment
getIdentityOidcAssignment 1 param → 200
GET
/identity/oidc/assignment/{name}
getIdentityOidcAssignmentName 1 param → 200
POST
/identity/oidc/assignment/{name}
postIdentityOidcAssignmentName 1 param body → 200
DELETE
/identity/oidc/assignment/{name}
deleteIdentityOidcAssignmentName 1 param → 204
GET
/identity/oidc/client
getIdentityOidcClient 1 param → 200
GET
/identity/oidc/client/{name}
getIdentityOidcClientName 1 param → 200
POST
/identity/oidc/client/{name}
postIdentityOidcClientName 1 param body → 200
DELETE
/identity/oidc/client/{name}
deleteIdentityOidcClientName 1 param → 204
GET
/identity/oidc/config
HashiCorp OIDC configuration
getIdentityOidcConfig → 200
POST
/identity/oidc/config
HashiCorp OIDC configuration
postIdentityOidcConfig body → 200
POST
/identity/oidc/introspect
HashiCorp Verify the authenticity of an OIDC token
postIdentityOidcIntrospect body → 200
GET
/identity/oidc/key
HashiCorp List OIDC keys
getIdentityOidcKey 1 param → 200
GET
/identity/oidc/key/{name}
HashiCorp CRUD operations for OIDC keys.
getIdentityOidcKeyName 1 param → 200
POST
/identity/oidc/key/{name}
HashiCorp CRUD operations for OIDC keys.
postIdentityOidcKeyName 1 param body → 200
DELETE
/identity/oidc/key/{name}
HashiCorp CRUD operations for OIDC keys.
deleteIdentityOidcKeyName 1 param → 204
POST
/identity/oidc/key/{name}/rotate
HashiCorp Rotate a named OIDC key.
postIdentityOidcKeyNameRotate 1 param body → 200
GET
/identity/oidc/provider
getIdentityOidcProvider 1 param → 200
GET
/identity/oidc/provider/{name}
getIdentityOidcProviderName 1 param → 200
POST
/identity/oidc/provider/{name}
postIdentityOidcProviderName 1 param body → 200
DELETE
/identity/oidc/provider/{name}
deleteIdentityOidcProviderName 1 param → 204
GET
/identity/oidc/provider/{name}/.well-known/keys
getIdentityOidcProviderNameWellKnownKeys 1 param → 200
GET
/identity/oidc/provider/{name}/.well-known/openid-configuration
getIdentityOidcProviderNameWellKnownOpenidConfiguration 1 param → 200
GET
/identity/oidc/provider/{name}/authorize
getIdentityOidcProviderNameAuthorize 1 param → 200
POST
/identity/oidc/provider/{name}/authorize
postIdentityOidcProviderNameAuthorize 1 param body → 200
POST
/identity/oidc/provider/{name}/token
postIdentityOidcProviderNameToken 1 param body → 200
GET
/identity/oidc/provider/{name}/userinfo
getIdentityOidcProviderNameUserinfo 1 param → 200
POST
/identity/oidc/provider/{name}/userinfo
postIdentityOidcProviderNameUserinfo 1 param → 200
GET
/identity/oidc/role
HashiCorp List configured OIDC roles
getIdentityOidcRole 1 param → 200
GET
/identity/oidc/role/{name}
HashiCorp CRUD operations on OIDC Roles
getIdentityOidcRoleName 1 param → 200
POST
/identity/oidc/role/{name}
HashiCorp CRUD operations on OIDC Roles
postIdentityOidcRoleName 1 param body → 200
DELETE
/identity/oidc/role/{name}
HashiCorp CRUD operations on OIDC Roles
deleteIdentityOidcRoleName 1 param → 204
GET
/identity/oidc/scope
getIdentityOidcScope 1 param → 200
GET
/identity/oidc/scope/{name}
getIdentityOidcScopeName 1 param → 200
POST
/identity/oidc/scope/{name}
postIdentityOidcScopeName 1 param body → 200
DELETE
/identity/oidc/scope/{name}
deleteIdentityOidcScopeName 1 param → 204
GET
/identity/oidc/token/{name}
HashiCorp Generate an OIDC token
getIdentityOidcTokenName 1 param → 200
POST
/identity/persona
HashiCorp Create a new alias.
postIdentityPersona body → 200
GET
/identity/persona/id
HashiCorp List all the alias IDs.
getIdentityPersonaId 1 param → 200
GET
/identity/persona/id/{id}
HashiCorp Update, read or delete an alias ID.
getIdentityPersonaIdId 1 param → 200
POST
/identity/persona/id/{id}
HashiCorp Update, read or delete an alias ID.
postIdentityPersonaIdId 1 param body → 200
DELETE
/identity/persona/id/{id}
HashiCorp Update, read or delete an alias ID.
deleteIdentityPersonaIdId 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-identity-api-openapi.yml Raw ↑

Other APIs HashiCorp publishes across the network.

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