Get a list of users

curl --request GET \
  --url https://{tenant_id}.hanko.io/admin/users \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "webauthn_credentials": [
      {
        "id": "f9bebc04-b894-4018-bdb8-8b520a532fef",
        "public_key": "<string>",
        "attestation_type": "<string>",
        "aaguid": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "backup_eligible": true,
        "backup_state": true,
        "mfa_only": true,
        "name": "<string>",
        "transports": [
          "<string>"
        ],
        "last_used_at": "2023-11-07T05:31:56Z"
      }
    ],
    "emails": [
      {
        "id": "802df042-1ac2-496d-af81-6ace729ed055",
        "address": "[email protected]",
        "is_verified": true,
        "is_primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "username": {
      "id": "8cbed467-554b-4d17-b23f-bce1b4f1db92",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
]

GET

users

Get a list of users

curl --request GET \
  --url https://{tenant_id}.hanko.io/admin/users \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "webauthn_credentials": [
      {
        "id": "f9bebc04-b894-4018-bdb8-8b520a532fef",
        "public_key": "<string>",
        "attestation_type": "<string>",
        "aaguid": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "backup_eligible": true,
        "backup_state": true,
        "mfa_only": true,
        "name": "<string>",
        "transports": [
          "<string>"
        ],
        "last_used_at": "2023-11-07T05:31:56Z"
      }
    ],
    "emails": [
      {
        "id": "802df042-1ac2-496d-af81-6ace729ed055",
        "address": "[email protected]",
        "is_verified": true,
        "is_primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "username": {
      "id": "8cbed467-554b-4d17-b23f-bce1b4f1db92",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your API key. Must only be used when using Hanko Cloud.

Query Parameters

page

integer

default:1

The page which should be returned

per_page

integer

default:20

The number of returned items

user_id

string<uuid4>

A single ID or a comma-separated list of IDs. Only users with the specified IDs are included in the result.

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

string<email>

Only users with the specified email are included

Example:

"[email protected]"

sort_direction

enum<string>

The sort direction of the returned list (always sorted by created_at)

Available options:

asc,

desc

Response

Details about users

string<uuid4>

required

The ID of the user

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

created_at

string<date-time>

required

Time of creation of the user

updated_at

string<date-time>

required

Time of last update of the user

webauthn_credentials

object[]

List of registered Webauthn credentials

Show child attributes

webauthn_credentials.id

string<uuid4>

required

The ID of the credential

Example:

"f9bebc04-b894-4018-bdb8-8b520a532fef"

webauthn_credentials.public_key

string

required

The public key of the credential

webauthn_credentials.attestation_type

string

required

The attestation type the credential was registered with

webauthn_credentials.aaguid

string

required

The AAGUID of the authenticator the credentials was created on

webauthn_credentials.created_at

string<date-time>

required

Time of creation of the credential

webauthn_credentials.backup_eligible

boolean

required

Indicates if the credential can be backed up

webauthn_credentials.backup_state

boolean

required

Indicates if the credential is backed up

webauthn_credentials.mfa_only

boolean

required

Indicates if the credential can only be used as a MFA credential

webauthn_credentials.name

string

A name that the user choose

webauthn_credentials.transports

string[]

The ways the authenticator is connected

webauthn_credentials.last_used_at

string<date-time>

The time when the credential was last used

emails

object[]

List of emails associated to the user

Show child attributes

emails.id

string<uuid4>

required

The ID of the email

Example:

"802df042-1ac2-496d-af81-6ace729ed055"

emails.address

string<email>

required

The email address

emails.is_verified

boolean

required

Indicated the email has been verified.

emails.is_primary

boolean

required

Indicates it's the primary email address.

emails.created_at

string<date-time>

required

Time of creation of the email

emails.updated_at

string<date-time>

required

Time of last update of the email

username

object

The username of the user

Show child attributes

username.id

string<uuid4>

The ID of the username

Example:

"8cbed467-554b-4d17-b23f-bce1b4f1db92"

username.created_at

string<date-time>

Time of creation of the username

username.updated_at

string<date-time>

Time of last update of the username

Status page Create a new user

⌘I

Getting started

Guides

Using the Hanko API

Integrations

Resources

FAQ & support

Get a list of users

Authorizations

Query Parameters

Response