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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hanko

Hanko Credentials API

The Credentials API from Hanko — 9 operation(s) for credentials.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

11 operations 9 paths 12 schemas 1 DELETE3 GET1 PATCH6 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
Contact
developers@hanko.io
License
AGPL-3.0-or-later
Resource Areas
1

Authentication & Security 1

Hanko Credentials 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 11

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

Credentials 11
DELETE
/{tenant_id}/credentials/{credential_id}
Remove Credential
delete-credentials-credentialId 3 params → 204400401404500
GET
/{tenant_id}/credentials/{credential_id}
Get a credential
get-credentials-credentialId 3 params body → 200400401404500
PATCH
/{tenant_id}/credentials/{credential_id}
Update Credential
patch-credentials-credentialId 3 params body → 204400401404500
GET
/{tenant_id}/credentials
List Credentials
get-credentials 6 params body → 200400401500
POST
/{tenant_id}/registration/initialize
Start Passkey Registration
post-registration-initialize 2 params body → 200400401500
POST
/{tenant_id}/registration/finalize
Finish Passkey Registration
post-registration-finalize 1 param body → 200400401404500
GET
/{tenant_id}/.well-known/jwks.json
Well-known JWKS
get-.well-known-jwks.json 1 param → 200
POST
/{tenant_id}/mfa/registration/initialize
Start MFA Registration
post-mfa-registration-initialize 2 params body → 200400401500
POST
/{tenant_id}/mfa/registration/finalize
Finish MFA Registration
post-mfa-registration-finalize 2 params body → 200400401404500
POST
/{tenant_id}/mfa/login/initialize
Start MFA Login
post-mfa-login-initialize 2 params body → 200400401404500
POST
/{tenant_id}/mfa/login/finalize
Finish MFA Login
post-mfa-login-finalize 2 params body → 200400401404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are webauthn-credential (11 properties), authentication-selection-entity (4 properties), public-key-user (3 properties), credential-descriptor-entity (3 properties). Each schema is shown below with its type and property counts.

credential-descriptor-entity
object
3 properties 2 required
credential
object
2 properties 2 required
public-key-user
object
3 properties 3 required
credential-parameter-entity
object
2 properties 2 required
webauthn-credential
object
11 properties 9 required
relying-party-entity
authenticator-attestation-response
autenticator-assertion-response
credential-entity
object
1 property 1 required
authenticator-response
object
1 property 1 required
public-key-credential
authentication-selection-entity
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hanko-credentials-api-openapi.yml Raw ↑

Other APIs Hanko publishes across the network.

Hanko Flow API
AE Profile APIs.io
Hanko Audit Logs API
AE Profile APIs.io
Hanko Email Management API
AE Profile APIs.io
Hanko Login API
AE Profile APIs.io
Hanko Metrics API
AE Profile APIs.io
Hanko mfa API
AE Profile APIs.io
Hanko Passcode API
AE Profile APIs.io
Hanko Password API
AE Profile APIs.io
Hanko SAML API
AE Profile APIs.io
Hanko Session Management API
AE Profile APIs.io
Hanko Sessions API
AE Profile APIs.io
Hanko Status API
AE Profile APIs.io
#Credentials
← Back to H APIs
API Details
ID
hanko:hanko-credentials-api
Base URL
https://{tenant_id}.hanko.io
Docs
https://docs.hanko.io
Provider
Hanko
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network