Skip to main content

User

User information

Parameters


id required string

User's unique identifier (uuid)


createdAt required string

The date-time when the user has been created


displayName required string

User's display name


avatarUrl required string

The URL to the user's profile picture


locale required string

The locale of the user, as a two-characters string


email optional string

User's email address


isAnonymous required boolean

Whether or not the user is anonymous


defaultRole required string

The default role of the user


roles required Array<string>

The roles assigned to the user


metadata required Record<string, unknown>

Additional attributes used for user information


emailVerified required boolean

Is true if the user email has not been verified


phoneNumber required null | string


phoneNumberVerified required boolean


activeMfaType required null | "totp"