Get third party user

Get a user’s information.

API is tenant specific if querying by email. If querying by userId, tenantId will be ignored.

Note that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.

GET/appid-{appId}/{tenantId}/recipe/user⠀deprecated

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.

Query parameters

userIdstring

thirdPartyIdthirdPartyId

Either use userId or thirdPartyId and thirdPartyUserId

thirdPartyUserIdthirdPartyUserId

Either use userId or thirdPartyId and thirdPartyUserId

Header parameters

ridstring

cdi-versionstring

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

Responses

200Get a user's information.

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

object

statusstring

Allowed:UNKNOWN_USER_ID_ERRORUNKNOWN_THIRD_PARTY_USER_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.userIdquerythirdPartyIdqueryEither use userId or thirdPartyId and thirdPartyUserIdthirdPartyUserIdqueryEither use userId or thirdPartyId and thirdPartyUserId

Request

curl -X GET "/appid-{appId}/public/recipe/user⠀" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/public/recipe/user⠀", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/public/recipe/user⠀",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "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"

"Not Found"

"Internal Error"