Create primary user account

Create a primary user for given user id

POST/appid-{appId}/recipe/accountlinking/user/primary

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

recipeUserIdstringrequired

The recipe user ID to create as primary user

Responses

200Indicates success with the status and primaryUserId properties

One of:

object

statusstatusOK

Allowed:OK

wasAlreadyAPrimaryUserboolean

Indicates if the user was already a primary user

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

object

statusstring

Allowed:ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR

primaryUserIdstring

The ID of the primary user that already has this account info

descriptionstring

Error description

object

statusstring

Allowed:RECIPE_USER_ID_ALREADY_LINKED_WITH_PRIMARY_USER_ID_ERROR

primaryUserIdstring

The ID of the primary user this recipe user is already linked to

descriptionstring

Error description

400error code 400

string

401error code 401

string

402error code 402

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

recipeUserIdstring*The recipe user ID to create as primary user

Request

curl -X POST "/appid-{appId}/recipe/accountlinking/user/primary" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "recipeUserId": "fa7a0841-b533-4478-9253-0fde890c576"
}'

const response = await fetch("/appid-{appId}/recipe/accountlinking/user/primary", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "recipeUserId": "fa7a0841-b533-4478-9253-0fde890c576"
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/accountlinking/user/primary",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "recipeUserId": "fa7a0841-b533-4478-9253-0fde890c576"
},
)

Response

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

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"