Check primary user creation possibility

Check if primary user can be created for given user id

GET/appid-{appId}/recipe/accountlinking/user/primary/check

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.

Query parameters

recipeUserIdstringrequired

Header parameters

ridstring

cdi-versionstring

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

Responses

200Indicates success with the status and canCreatePrimaryUser properties

One of:

object

statusstatusOK

Allowed:OK

wasAlreadyAPrimaryUserboolean

Indicates if the user was already a primary user

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

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.recipeUserIdquery*

Request

curl -X GET "/appid-{appId}/recipe/accountlinking/user/primary/check?recipeUserId=fa7a0841-b533-4478-9253-0fde890c576" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/recipe/accountlinking/user/primary/check?recipeUserId=fa7a0841-b533-4478-9253-0fde890c576", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/recipe/accountlinking/user/primary/check?recipeUserId=fa7a0841-b533-4478-9253-0fde890c576",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "wasAlreadyAPrimaryUser": true
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"