Start passwordless sign in/up
Start sign in/up process with passwordless
POST
/{apiBasePath}/{tenantId}/signinup/codePath 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 passwordless recipe ID
Request body
application/jsonOne of:
object
emailemailrequiredEmail address
shouldTryLinkingWithSessionUserbooleanobject
phoneNumberphoneNumberrequiredPhone number
shouldTryLinkingWithSessionUserbooleanResponses
200Started the passwordless sign in/up process.
One of:
object
statusstatusOKSuccess status indicator
Allowed:
OKdeviceIddeviceIdThis should be saved on the starting device to enable the manual code entry flow.
preAuthSessionIdpreAuthSessionIdAn identifier that used to identify the login attempt/device.
flowTypestringAllowed:
MAGIC_LINKUSER_INPUT_CODE_AND_MAGIC_LINKUSER_INPUT_CODEobject
statusstringAllowed:
SIGN_IN_UP_NOT_ALLOWEDreasonstringgeneralErrorResponse
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/signinup/code" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"shouldTryLinkingWithSessionUser": false
}'const response = await fetch("/auth/public/signinup/code", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"email": "[email protected]",
"shouldTryLinkingWithSessionUser": false
})
});import requests
response = requests.post(
"/auth/public/signinup/code",
headers={
"Content-Type": "application/json"
},
json={
"email": "[email protected]",
"shouldTryLinkingWithSessionUser": False
},
)Response
{
"status": "OK",
"deviceId": "TU/52WOcktSv99zqaAZuWJG9BSoS0aRLfCbep8rFEwk=",
"preAuthSessionId": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs=",
"flowType": "MAGIC_LINK"
}{
"message": "invalid claim",
"claimValidationErrors": [
{
"id": "st-ev",
"reason": {
"message": "wrong value",
"expectedValue": true,
"actualValue": false
}
}
]
}"Not Found""Internal Error"