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

Hanko User Management API

The User Management API from Hanko — 5 operation(s) for user management.

Hanko User Management API is one of 22 APIs that Hanko publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.0.3, at version 1.2.0.

Requests are made against a single base URL, https://{tenant_id}.hanko.io/admin.

9 operations 5 paths 19 schemas 2 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.2.0
Base URL
https://{tenant_id}.hanko.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hanko User Management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (BearerApiKeyAuth).

  • BearerApiKeyAuth — Bearer authentication header of the form Bearer , where is your API key. Must only be used when using Hanko Cloud.

Paths & Operations 9

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

User Management 9
GET
/users
Get a list of users
listUsers 5 params → 200400500
POST
/users
Create a new user
createUser body → 200400409500
DELETE
/users/{id}
Delete a user by ID
deleteUser 1 param → 204404500
GET
/users/{id}
Get a user by ID
getUser 1 param → 200400404500
PATCH
/users/{id}
Update a user by ID
patchUser 1 param body → 200400404500
POST
/userdeprecated
Get user details by email
getUserId body → 200400404500
DELETE
/userdeprecated
Deletes the current user
deleteUser → 204401500
GET
/me
Get the current user
IsUserAuthorized → 200400401500
POST
/logout
Log out the current user
logout → 204401500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are UserBase_2 (13 properties), WebAuthnCredential (11 properties), WebauthnCredential (11 properties), Email (6 properties). Each schema is shown below with its type and property counts.

Emails
array
OTP
object
2 properties 2 required
Identity_2
object
Representation of a user's third party connection/identity.
3 properties
UserMetadata
object
User metadata
3 properties
Identities
array
A list of third party provider identities
Identities_2
array
The user's third party connections/identities.
Username
object
The username of the user
4 properties
Email
object
6 properties 6 required
Password
object
The password credential of a user
3 properties
WebAuthnCredential
object
11 properties 8 required
Username_2
object
The representation of a username of the user
4 properties
Error
object
2 properties 2 required
UserBase_2
object
13 properties
User
WebauthnCredential
object
11 properties
UUID4
string
Identity
object
A third party provider identity
6 properties
UserBase
object
6 properties 3 required
UserMetadata_2
object
The public and unsafe metadata of a user
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hanko-user-management-api-openapi.yml Raw ↑

Other APIs Hanko publishes across the network.

Hanko Flow API
Hanko Audit Logs API
Hanko Credentials API
Hanko Email Management API
Hanko Login API
Hanko Metrics API
Hanko mfa API
Hanko Passcode API
Hanko Password API
Hanko SAML API
Hanko Session Management API
Hanko Sessions API