Dashboard Sessions

Endpoints for managing dashboard user sessions

Sign In

cURL

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

200 OK

{
  "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

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

200 OK

{
  "status": "OK",
  "email": "[e-mail]"
}

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

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

200 OK

{
  "status": "OK"
}

sessionId · string · required

The session ID to revoke

status · string

“OK”