Xsolla-logo

Start auth by email

post/login/email/request

Starts authentication by the user email address and sends a confirmation code to their email address. The code lifetime is 3 minutes.

This call is used only with the Complete auth by email call.

The workflow of using this call:

  1. The application opens an authentication form so the user can enter their email address.
  2. The user enters their email address.
  3. The application sends this request to the Xsolla Login server: a. If the parameter send_link is true, after this request, you should send the Get confirmation code request to make email contain the confirmation code and link. b. If the parameter send_link is false or not passed, the email will contain the confirmation code only.
  4. The Xsolla Login server sends the email and returns the ID of the confirmation code.
  5. The application shows a field so the user can fill in the confirmation code.
  6. The user enters the received confirmation code or follows the linke.
  7. The application sends the Complete auth by email request with the received ID to the Xsolla Login server.
  8. The user is considered as authorized.
Request
query Parameters
projectId
required
string <uuid>

Login project ID from Publisher Account.

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. To find it, go to Login > your Login project > General settings. Required if there are several Callback URLs.

payload
string

Your custom data. The value of the parameter will be returned in the payload claim of the user JWT.

with_logout
string
Default: "0"

Shows whether to deactivate the existing user JWT values and activate the one generated by this call. Can have the following values:

  • 1 to deactivate the existing values and activate a new one,
  • 0 to keep the existing values activated.
Request Body schema: application/json
email
required
string [ 1 .. 255 ] characters

User email address.

link_url
string <uri>

URL to redirect the user to the status authentication page. Required if the parameter send_link is true.

send_link
boolean

Shows whether a link is sent with the confirmation code in the email or not.

The link can be used instead of the confirmation code to log in.

If the parameter has the true value, the link is sent in the email.

Responses
200

OK

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/json
{}
Response samples
application/json
{
  • "operation_id": "string"
}