Sign in with email
Signin a user with email ID and password
POST
/{apiBasePath}/{tenantId}/signinPath parameters
apiBasePathstringrequiredIts value depends on the apiBasePath set by the user
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Header parameters
ridstringThe recipe ID for the request
Request body
application/jsonformFieldsformFieldsrequiredForm fields for authentication
Show propertiesHide properties
Array of
objectididField identifier
Allowed:
emailpasswordvaluestringField value
shouldTryLinkingWithSessionUserbooleanResponses
200Sign in Response
One of:
signInResponse
statusstatusOKSuccess status indicator
Allowed:
OKuseruserUser information
Show propertiesHide properties
iduserIdUnique identifier for a user
timeJoinednumberTimestamp when user joined
isPrimaryUserbooleanWhether this is the primary user account
tenantIdsstring[]List of tenant IDs the user belongs to
emailsstring[]List of user's email addresses
phoneNumbersstring[]List of user's phone numbers
thirdPartyobject[]List of third party accounts
Show propertiesHide properties
Array of
objectidstringThird party provider ID
userIdstringUser ID in the third party system
loginMethodsobject[]List of login methods available to the user
Show propertiesHide properties
Array of
objectrecipeIdstringThe recipe ID for this login method
Allowed:
emailpasswordthirdpartypasswordlessrecipeUserIduserIdUnique identifier for a user
verifiedbooleanWhether this login method is verified
tenantIdsstring[]List of tenant IDs for this login method
timeJoinednumberTimestamp when this login method was added
emailstringEmail address for this login method
phoneNumberstringPhone number for this login method
thirdPartyobjectThird party information for this login method
Show propertiesHide properties
idstringThird party provider ID
userIdstringUser ID in the third party system
signInNotAllowedResponse
statusstringError status
Allowed:
SIGN_IN_NOT_ALLOWEDreasonstringReason why sign in is not allowed
fieldErrorResponse
statusstringError status
Allowed:
FIELD_ERRORformFieldsobject[]List of field errors
Show propertiesHide properties
Array of
objectidstringField ID
errorstringError message
wrongCredentialsResponse
statusstringError status
Allowed:
WRONG_CREDENTIALS_ERRORgeneralErrorResponse
statusstringError status code
Allowed:
GENERAL_ERRORmessagestringError message
403A claim validation error happened during factor setup
One of:
object
messagestringError message
claimValidationErrorsobject[]List of claim validation errors
Show propertiesHide properties
Array of
objectidstringThe claim ID
reasonobjectThe reason for the validation error
object
messagestringError message
claimValidationErrorsobject[]List of claim validation errors
Show propertiesHide properties
Array of
objectidstringThe claim ID
reasonstringThe reason for the validation error
404Resource not found error
string500Internal server error
stringTry it
Server
Parameters
Bodyapplication/json
Request
curl -X POST "/auth/public/signin" \
-H "Content-Type: application/json" \
-d '{
"formFields": [
{
"id": "email",
"value": "[email protected]"
},
{
"id": "password",
"value": "testPass123"
}
],
"shouldTryLinkingWithSessionUser": false
}'const response = await fetch("/auth/public/signin", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"formFields": [
{
"id": "email",
"value": "[email protected]"
},
{
"id": "password",
"value": "testPass123"
}
],
"shouldTryLinkingWithSessionUser": false
})
});import requests
response = requests.post(
"/auth/public/signin",
headers={
"Content-Type": "application/json"
},
json={
"formFields": [
{
"id": "email",
"value": "[email protected]"
},
{
"id": "password",
"value": "testPass123"
}
],
"shouldTryLinkingWithSessionUser": False
},
)Response
{
"status": "OK",
"user": {
"id": "fa7a0841-b533-4478-95533-0fde890c3483",
"timeJoined": 1638433545183,
"isPrimaryUser": true,
"tenantIds": [
"public"
],
"emails": [
"[email protected]"
],
"phoneNumbers": [
36201234123
],
"thirdParty": [
{
"id": "google",
"userId": "rq238mrq2389rvq123213"
}
],
"loginMethods": [
{
"recipeId": "emailpassword",
"recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
"verified": true,
"tenantIds": [
"public"
],
"timeJoined": 1638433545183,
"email": "[email protected]",
"phoneNumber": 36201234123,
"thirdParty": {
"id": "google",
"userId": "rq238mrq2389rvq123213"
}
}
]
}
}{
"message": "invalid claim",
"claimValidationErrors": [
{
"id": "st-ev",
"reason": {
"message": "wrong value",
"expectedValue": true,
"actualValue": false
}
}
]
}"Not Found""Internal Error"