Authentication by magic link

Authenticates the user with the given email and brand URL. We send an email to the user with a link to authenticate.

post

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

This is the model class for UserAuthenticationByEmail.

emailAddressstring · min: 1Required

This represents the email address of the user.

Default: [e-mail]

callbackUrlstring · uri · min: 1Required

This represents the callback url.

returnUrlstring | nullableOptional

This represents the return url.

Responses

200

The request was successful.

application/json

400

Request is invalid

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/auth/by-email HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "emailAddress": "text",
  "callbackUrl": "https://example.com",
  "returnUrl": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}