Create dashboard user

Create a dashboard user

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

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

userobject

Show properties

userIdstring

emailstring

timeCreatednumber

object

statusstring

Allowed:EMAIL_ALREADY_EXISTS_ERROR

object

statusstring

Allowed:PASSWORD_WEAK_ERROR

messagestring

object

statusstring

Allowed:INVALID_EMAIL_ERROR

400error code 400

string

401error code 401

string

402Indicates ayment required

statusstring

Allowed:USER_LIMIT_REACHED_ERROR

messagestring

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/user" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "test@example.com",
  "password": "password@123"
}'

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

import requests

response = requests.post(
    "/appid-{appId}/recipe/dashboard/user",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "email": "test@example.com",
  "password": "password@123"
},
)

Response

{
  "status": "OK",
  "user": {
    "userId": "example-userid",
    "email": "test@example.com",
    "timeCreated": 1231321231
  }
}

"string"

"Invalid API key"

{
  "status": "USER_LIMIT_REACHED_ERROR",
  "message": "You have reached the free limit for creating users, please purchase the dashboard feature to create new users"
}

"Not Found"

"Internal Error"