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

Represents all objects which are related to MFA in common

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

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

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

4 operations 4 paths 11 schemas 4 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 mfa 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 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

mfa 4

Represents all objects which are related to MFA in common

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 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are authentication-selection-entity (4 properties), public-key-user (3 properties), credential-descriptor-entity (3 properties), credential-parameter-entity (2 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
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-mfa-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 Passcode API
Hanko Password API
Hanko SAML API
Hanko Session Management API
Hanko Sessions API
Hanko Status API