Skip to main content

The User Object

Users represent end-users in your application. Each user can have multiple authentication methods and custom metadata.

Attributes

string
required
Unique identifier for the user (app user ID)Example: usr_1234567890
string
required
Application ID this user belongs to
string
required
Base user ID (platform-level identifier)
string
required
User status. Can be active, pending, inactive, or importedExample: active
string
User email addressExample: user@example.com
string
User phone numberExample: +1234567890
string
User full nameExample: John Doe
boolean
Whether the user’s email has been verifiedExample: true
boolean
Whether the user’s phone has been verifiedExample: false
integer
Number of times the user has logged inExample: 42
string
ISO 8601 timestamp of the user’s last login
object
Custom metadata object with user-defined fieldsExample: { "first_name": "John", "last_name": "Doe", "company": "Acme Corp" }
string
required
ISO 8601 timestamp when the user was created
string
required
ISO 8601 timestamp when the user was last updated

Example User Object