Sign up user

Signup a user with email ID and password

POST/appid-{appId}/{tenantId}/recipe/signup

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.

Path parameters

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

cdi-versionstring

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

Request body

application/json

emailemail

passwordpassword

Responses

200signup response

One of:

object

statusstatusOK

Allowed:OK

userauthRecipeUser

Show properties

iduserId

isPrimaryUserboolean

tenantIdstenantId[]

timeJoinedtimeJoined

emailsemail[]

phoneNumbersphoneNumber[]

thirdPartyobject[]

Show properties

Array of object

idthirdPartyId

userIdthirdPartyUserId

loginMethodsobject[]

Show properties

Array of object

tenantIdstenantId[]

recipeUserIduserId

verifiedboolean

timeJoinedtimeJoined

recipeIdrecipeId

Allowed:emailpasswordpasswordlessthirdparty

emailemail

phoneNumberphoneNumber

thirdPartyobject

Show properties

idthirdPartyId

userIdthirdPartyUserId

recipeUserIduserId

object

statusstring

Allowed:EMAIL_ALREADY_EXISTS_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

tenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

emailstringpasswordstring

Request

curl -X POST "/appid-{appId}/public/recipe/signup" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "johndoe@gmail.com",
  "password": "password123"
}'

const response = await fetch("/appid-{appId}/public/recipe/signup", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "email": "johndoe@gmail.com",
  "password": "password123"
})
});

import requests

response = requests.post(
    "/appid-{appId}/public/recipe/signup",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "email": "johndoe@gmail.com",
  "password": "password123"
},
)

Response

{
  "status": "OK",
  "user": {
    "id": "fa7a0841-b533-4478-95533-0fde890c3483",
    "isPrimaryUser": true,
    "tenantIds": [
      "customer1"
    ],
    "timeJoined": 1623918032231,
    "emails": [
      "johndoe@gmail.com"
    ],
    "phoneNumbers": [
      "+14155552671"
    ],
    "thirdParty": [
      {
        "id": "google",
        "userId": 106347997792363870000
      }
    ],
    "loginMethods": [
      {
        "tenantIds": [
          "customer1"
        ],
        "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
        "verified": true,
        "timeJoined": 1623918032231,
        "recipeId": "emailpassword",
        "email": "johndoe@gmail.com",
        "phoneNumber": "+14155552671",
        "thirdParty": {
          "id": "google",
          "userId": 106347997792363870000
        }
      }
    ]
  },
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"