signInEmail

POST

/api/auth/sign-in/email

curl --request POST \
  --url https://example.com/api/auth/sign-in/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "password": "example", "callbackURL": "example", "rememberMe": true }'

Sign in with email and password

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

email

required

Email of the user

string

password

required

Password of the user

string

callbackURL

Callback URL to use as a redirect for email verification

string

rememberMe

If this is false, the session will not be remembered. Default is true.

boolean

Example^generated

{
  "email": "example",
  "password": "example",
  "callbackURL": "example",
  "rememberMe": true
}

Responses

200

Success - Returns either session details or redirect URL

Media typeapplication/json

Session response when idToken is provided

object

redirect

required

boolean

token

required

Session token

string

url

string

nullable

user

required

object

id

required

string

name

required

string

email

required

string

emailVerified

required

boolean

image

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

twoFactorEnabled

boolean

Example

{
  "redirect": false,
  "user": {
    "emailVerified": false,
    "twoFactorEnabled": false
  }
}

400

Bad Request. Usually due to missing parameters, or invalid parameters.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Forbidden. You do not have permission to access this resource or to perform this action.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

Too Many Requests. You have exceeded the rate limit. Try again later.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

Internal Server Error. This is a problem with the server that you cannot fix.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}