Get passwordless user
Get a user’s information.
API is tenant specific if querying by email or phone number. 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 ⠀deprecatedAuthorization
api-keyAPI key · headerrequiredThe 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
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Query parameters
userIdstringemailemailUse exactly one of phoneNumber, email or userId
phoneNumberphoneNumberUse exactly one of phoneNumber, email or userId
Header parameters
ridstringcdi-versionstringX.Y of the X.Y.Z CDI version.
Responses
200Get a user's information.
One of:
object
statusstatusOKAllowed:
OKuserauthRecipeUserShow propertiesHide properties
iduserIdisPrimaryUserbooleantenantIdstenantId[]timeJoinedtimeJoinedemailsemail[]phoneNumbersphoneNumber[]thirdPartyobject[]Show propertiesHide properties
Array of
objectidthirdPartyIduserIdthirdPartyUserIdloginMethodsobject[]Show propertiesHide properties
Array of
objecttenantIdstenantId[]recipeUserIduserIdverifiedbooleantimeJoinedtimeJoinedrecipeIdrecipeIdAllowed:
emailpasswordpasswordlessthirdpartyemailemailphoneNumberphoneNumberthirdPartyobjectShow propertiesHide properties
idthirdPartyIduserIdthirdPartyUserIdobject
statusstringAllowed:
UNKNOWN_USER_ID_ERRORUNKNOWN_EMAIL_ERRORUNKNOWN_PHONE_NUMBER_ERROR400error code 400
string401error code 401
string404error code 404
string500error code 500
stringTry it
Server
Authorization
Parameters
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"