Skip to main content

​
Sign In

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

{
  "status": "OK",
  "sessionId": "session-id-string"
}
​
email
string
required
Dashboard user’s email address (will be normalized)
​
password
string
required
Dashboard user’s password
​
status
string
“OK”, “INVALID_CREDENTIALS_ERROR”, or “USER_SUSPENDED_ERROR”
​
sessionId
string
Session identifier for authenticated dashboard user
​
message
string
Additional message for USER_SUSPENDED_ERROR status

​
Verify Session

curl -X POST https://your-domain.com/recipe/dashboard/session/verify \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "session-id-string"
  }'

{
  "status": "OK",
  "email": "[email protected]"
}
​
sessionId
string
required
The session ID to verify
​
status
string
“OK”, “INVALID_SESSION_ERROR”, or “USER_SUSPENDED_ERROR”
​
email
string
Email address of the authenticated dashboard user (returned for CDI version 3.0+)
​
message
string
Additional message for USER_SUSPENDED_ERROR status

​
Revoke Session

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

{
  "status": "OK"
}
​
sessionId
string
required
The session ID to revoke
​
status
string
“OK”

Build docs developers (and LLMs) love

Get started for freeTalk to us