Skip to main content

Hanko Admin API (0.2.0)

Introduction

This is the OpenAPI specification for the Hanko Admin API.

Authentication

The Admin API must be protected by an access management system.


User Management

Get a list of users

Responses

Response Schema: application/json
Array
id
string <uuid4>

The ID of the user

email
string <email>

The email address of the user

created_at
string <date-time>

Time of creation of the the user

updated_at
string <date-time>

Time of last update of the user

verified
boolean

Indicates whether the user's email address was verified

Array of objects

List of registered Webauthn credentials

Response samples

Content type
application/json
[
  • {
    • "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    • "email": "user@example.com",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "verified": true,
    • "webauthn_credentials": [
      ]
    }
]

Update a user by ID

path Parameters
id
required
string <uuid4> (UUID4)
Example: c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c

ID of the user

Request Body schema: application/json
email
string <email>
status
string
Enum: "active" "inactive"

Responses

Response Schema: application/json
id
string <uuid4>

The ID of the user

email
string <email>

The email address of the user

created_at
string <date-time>

Time of creation of the the user

updated_at
string <date-time>

Time of last update of the user

verified
boolean

Indicates whether the user's email address was verified

Array of objects

List of registered Webauthn credentials

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  • "email": "user@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "verified": true,
  • "webauthn_credentials": [
    • {
      }
    ]
}

Delete a user by ID

path Parameters
id
required
string <uuid4> (UUID4)
Example: c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c

ID of the user

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Not found"
}