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

The Users API from Hanko — 9 operation(s) for users.

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

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

This API exposes 16 operations across 9 paths, and defines 8 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.

16 operations 9 paths 8 schemas 5 DELETE7 GET3 POST1 PUT

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 Users 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 16

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

Users 16
GET
/users/{id}/emails
Get a list of emails for a user
get-users-id-emails 1 param → 200400500
POST
/users/{id}/emails
Create an email for a user
post-users-id-emails 1 param body → 201400404409500
GET
/users/{id}/emails/{email_id}
Get an email of a user
get-users-id-emails-email_id 2 params → 200400404500
DELETE
/users/{id}/emails/{email_id}
Remove an email from a user
delete-users-emails-email_id 2 params → 204400404409500
POST
/users/{id}/emails/{email_id}/set_primary
Set email as primary
post-users-emails-email_id-set_primary 2 params → 204400404500
GET
/users/{id}/sessions
Get users active sessions
get-users-sessions 1 param → 200400404500
DELETE
/users/{id}/sessions/{session_id}
Delete a session from a user
delete-users-sessions-session_id 2 params → 204400404500
GET
/users/{id}/otp
Get the OTP secret metadata of a user
get-users-otp 1 param → 200400404500
DELETE
/users/{id}/otp
Delete the OTP secret from a user
delete-users-otp 1 param → 204400404500
GET
/users/{id}/webauthn_credentials
Get a list of all WebAuthn credentials for a user
get-users-webauthn_credentials 1 param → 200400404500
GET
/users/{id}/webauthn_credentials/{credential_id}
Get a WebAuthn credential of a user
get-users-webauthn_credentials-credential_id 2 params → 200400404500
DELETE
/users/{id}/webauthn_credentials/{credential_id}
Delete a WebAuthn credential from a user
delete-users-webauthn_credentials-credential_id 2 params → 204400404500
GET
/users/{id}/password
Get password metadata of a user
get-users-password 1 param → 200400404500
POST
/users/{id}/password
Create a password for a user
post-users-password 1 param body → 200400404500
PUT
/users/{id}/password
Update the password for a user
put-users-password 1 param body → 200400404500
DELETE
/users/{id}/password
Delete the password of a user
delete-users-password 1 param → 204400404500

Schemas 8

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

CreatePassword
object
1 property
UUID4
string
Error
object
2 properties 2 required
Session
object
8 properties 5 required
Password
object
The password credential of a user
3 properties
OTP
object
2 properties 2 required
Email
object
6 properties 6 required
WebAuthnCredential
object
11 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hanko-users-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