Get a list of users

Authorizations

Authorization

string

headerrequired

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

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

email

string

Only users with the specified email are included

sort_direction

enum<string>

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

Available options:

asc,

desc

Response

200 - application/json

id

string

required

The ID of the user

created_at

string

required

Time of creation of the user

updated_at

string

required

Time of last update of the user

webauthn_credentials

object[]

List of registered Webauthn credentials

Show child attributes

webauthn_credentials.id

string

required

The ID of the credential

webauthn_credentials.name

string

A name that the user choose

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.transports

string[]

The ways the authenticator is connected

webauthn_credentials.created_at

string

required

Time of creation of the credential

webauthn_credentials.last_used_at

string

The time when the credential was last used

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

emails

object[]

List of emails associated to the user

Show child attributes

emails.id

string

required

The ID of the email

emails.address

string

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

required

Time of creation of the email

emails.updated_at

string

required

Time of last update of the email

username

object

The username of the user

Show child attributes

username.id

string

The ID of the username

username.created_at

string

Time of creation of the username

username.updated_at

string

Time of last update of the username

password

object

The password credential of a user

Show child attributes

password.id

string

The ID of the password credential

password.created_at

string

Time of creation of the password credential

password.updated_at

string

Time of last update of the password credential

identities

object[]

A list of third party provider identities

Show child attributes

identities.id

string

The ID of the identity

identities.email_id

string

The ID of the email this identity is coupled with

identities.provider_id

string

The user's third party provider account/user ID

identities.provider_name

string

The name of the third party provider this identity coupled with

identities.created_at

string

Time of creation of the password credential

identities.updated_at

string

Time of last update of the password credential