Skip to main content
GET
Get a user by ID

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.

Path Parameters

id
string<uuid4>
required

ID of the user

Example:

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

Response

Details about the user

id
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

emails
object[]

List of emails associated to the user

username
object

The username of the user

name
string

The user's full name. Omitted if not set.

Example:

"John Doe"

given_name
string

The user's given name (first name). Omitted if not set.

Example:

"John"

family_name
string

The user's family name (surname). Omitted if not set.

Example:

"Doe"

picture
string<uri>

URL of the user's profile picture. Omitted if not set.

Example:

"https://example.com/avatar.jpg"

organizations
object[]

Organizations the user belongs to, and the roles held in each. Omitted if the user belongs to no organizations.

otp
object
password
object

The password credential of a user

identities
object[]

A list of third party provider identities

metadata
object

User metadata

custom_claims
object

A user's resolved custom claims, keyed by claim name

Example: