signInOTPEmail

Initiate email-based one-time password authentication. Sends an OTP to the specified email address. If the user doesn’t exist, a new account will be created with the provided options.

POST /signin/otp/email

Sign in with email OTP

cURL

curl --request POST \
  --url https://{subdomain}.auth.{region}.nhost.run/v1/signin/otp/email \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}
'

200

"OK"

Body

application/json

Email address and optional user options for OTP authentication

email · string<email> · required

A valid email

Example:

"[e-mail]"

options · object

Show child attributes

options. allowedRoles · string[]

Example:

["me", "user"]

options. defaultRole · string

Example:

"user"

options. displayName · string

Maximum string length: 32

Example:

"John Smith"

options. locale · string

A two-characters locale

Required string length: 2

Example:

"en"

options. metadata · object

Example:

{ "firstName": "John", "lastName": "Smith" }

options. redirectTo · string<uri>

Example:

"https://my-app.com/catch-redirection"

Response

200

application/json

OTP sent to user's email successfully

The response is of type enum<string>.

Available options: OK