Sign in dashboard user

Signin a Dashboard user

POST/appid-{appId}/recipe/dashboard/signin

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

ridstring

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

emailstring

passwordstring

Responses

200Indicates success with the status property

One of:

object

statusstring

Allowed:OK

sessionIdstring

object

statusstring

Allowed:USER_SUSPENDED_ERROR

messagestring

object

statusstring

Allowed:INVAlID_CREDENTIALS_ERROR

400error code 400

string

401error code 401

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

emailstringpasswordstring

Request

curl -X POST "/appid-{appId}/recipe/dashboard/signin" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "[email protected]",
  "password": "password@123"
}'

const response = await fetch("/appid-{appId}/recipe/dashboard/signin", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "email": "[email protected]",
  "password": "password@123"
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/dashboard/signin",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "email": "[email protected]",
  "password": "password@123"
},
)

Response

{
  "status": "OK",
  "sessionId": null
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"