Xsolla-logo

メールによる認証を開始する

post/login/email/request

ユーザーのメールアドレスによる認証を開始し、ユーザーのメールアドレスに確認コードを送信します。コードの有効期限は3分です。

このコールは、メールによる認証を完了するコールでのみ使用されます。

このコールを使用するワークフロー:

  1. アプリケーションは認証フォームを開き、ユーザーはメールアドレスを入力することができます。
  2. ユーザーが自分のメールアドレスを入力します。
  3. アプリケーションはこのリクエストをエクソラログインサーバーに送信します: a. パラメータsend_linktrueの場合、このリクエストの後に確認コートを取得するリクエストを送信して、確認コードとリンクを含むメールを作成する必要があります。 b. パラメータsend_linkfalseまたは渡されない場合、メールには確認コードのみが含まれます。
  4. エクソラログインサーバーはメールを送信し、確認コードのIDを返します。
  5. アプリケーションには、ユーザーが確認コードを入力するためのフィールドが表示されます。
  6. ユーザーは、受け取った確認コードを入力するか、リンクをたどります。
  7. アプリケーションはメールによる認証を完了するリクエストを受け取ったIDでエクソラログインサーバーに送信します。
  8. ユーザーは認可されたとみなされます。
Request
query Parameters
projectId
required
string <uuid>

パブリッシャーアカウントからのログインプロジェクトID。

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 and select the Callback URLs section in the upper block of the navigation page. Required if there are several Callback URLs.

payload
string

カスタムデータ。パラメータの値は、ユーザーJWTpayloadクレームで返されます。

with_logout
string
Default: "0"

既存のユーザーJWT値を非アクティブ化し、このコールによって生成されたものをアクティブ化するかどうかを示します。次の値を指定できます。

  • 1 は、既存の値を非アクティブ化し、新しい値をアクティブ化します。
  • 0 は、既存の値をアクティブ化したままにします。
Request Body schema: application/json
email
required
string [ 1 .. 255 ] characters

ユーザーのメールアドレス。

link_url
string <uri>

ユーザーをステータス認証ページにリダイレクトするためのURL。パラメータsend_linktrueの場合は、必須です。

send_link
boolean

メールに確認コードと一緒にリンクを送信するかどうかを示します。

このリンクは、確認コードの代わりにログインに使用することができます。

パラメータにtrue値が設定されている場合、メール内にリンクが送信されます。

Responses
200

OK

400

bad request

404

見つかりません

422

処理不可能なエンティティー

429

リクエストの回数が多すぎます

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