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

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

​
Example User Object

{
  "id": "usr_1234567890",
  "app_id": "app_123",
  "user_id": "user_abc",
  "status": "active",
  "email": "user@example.com",
  "phone": "+1234567890",
  "name": "John Doe",
  "email_verified": true,
  "phone_verified": false,
  "login_count": 42,
  "last_login_at": "2024-01-15T10:30:00Z",
  "user_meta": {
    "first_name": "John",
    "last_name": "Doe",
    "company": "Acme Corp",
    "role": "Developer"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}