Skip to main content

​
List Dashboard Users

curl -X GET https://your-domain.com/recipe/dashboard/users \
  -H "Content-Type: application/json"

{
  "status": "OK",
  "users": [
    {
      "userId": "user-id-1",
      "email": "[email protected]",
      "timeJoined": 1234567890000
    },
    {
      "userId": "user-id-2",
      "email": "[email protected]",
      "timeJoined": 1234567900000
    }
  ]
}
​
status
string
“OK”
​
users
array
Array of dashboard user objects
​
users[].userId
string
Unique identifier for the dashboard user
​
users[].email
string
Email address of the dashboard user
​
users[].timeJoined
number
Timestamp when user was created (milliseconds since epoch)

​
Create Dashboard User

curl -X POST https://your-domain.com/recipe/dashboard/user \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "StrongPassword123!"
  }'

{
  "status": "OK",
  "user": {
    "userId": "user-id",
    "email": "[email protected]",
    "timeJoined": 1234567890000
  }
}
​
email
string
required
Email address for the new dashboard user (will be normalized and validated)
​
password
string
required
Password for the new dashboard user (must meet strength requirements)
​
status
string
“OK”, “INVALID_EMAIL_ERROR”, “PASSWORD_WEAK_ERROR”, or “EMAIL_ALREADY_EXISTS_ERROR”
​
user
object
Created dashboard user object
​
message
string
Additional message for PASSWORD_WEAK_ERROR status explaining requirements

​
Update Dashboard User

curl -X PUT https://your-domain.com/recipe/dashboard/user \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "user-id",
    "newEmail": "[email protected]",
    "newPassword": "NewStrongPassword123!"
  }'

{
  "status": "OK",
  "user": {
    "userId": "user-id",
    "email": "[email protected]",
    "timeJoined": 1234567890000
  }
}
​
userId
string
The user ID to update (either userId or email must be provided)
​
email
string
The email address to look up the user (either userId or email must be provided)
​
newEmail
string
New email address (optional, will be normalized and validated)
​
newPassword
string
New password (optional, must meet strength requirements)
​
status
string
“OK”, “INVALID_EMAIL_ERROR”, “PASSWORD_WEAK_ERROR”, “EMAIL_ALREADY_EXISTS_ERROR”, or “UNKNOWN_USER_ERROR”
​
user
object
Updated dashboard user object
​
message
string
Additional message for PASSWORD_WEAK_ERROR status

​
Delete Dashboard User

curl -X DELETE "https://your-domain.com/recipe/dashboard/user?userId=user-id" \
  -H "Content-Type: application/json"

{
  "status": "OK",
  "didUserExist": true
}
​
userId
string
The user ID to delete (either userId or email must be provided)
​
email
string
The email address to look up and delete the user (either userId or email must be provided)
​
status
string
“OK”
​
didUserExist
boolean
Whether the user existed before deletion

Build docs developers (and LLMs) love

Get started for freeTalk to us