Xsolla-logo

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

post/oauth2/login/email/request

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

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

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

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

OAuth 2.0プロトコルが有効なプロジェクトで使用されるグラントタイプ応答に含まれるユーザー認証コードを取得するためにcodeである必要があります。受け取ったコードはJWTを生成するのコールによってJWTに交換され、ユーザー認証が完了する必要があります。

client_id
required
integer

アプリケーションID。OAuth 2.0クライアントを作成した後で取得します。

state
required
string

追加のユーザー認証に使用される値。CSRF攻撃を軽減するためによく使用されます。この値は応答で返されます。8文字以上の文字列である必要があります。

scope
string

スコープとは、OAuth 2.0において、アプリケーションによるユーザーアカウントへのアクセスを制限するためのメカニズムです。

以下の値を指定できます:

  • offlineは、JWTを生成するコールからrefresh_tokenを使用して、期限切れになったときにJWTをリフレッシュします。
  • playfab PlayFabにユーザーデータを保存する場合、JWTのsession_ticketクレームにSessionTicketを書き込みます。

上記以外のscopeパラメータの値を独自に処理する場合、このコールを使用する際に設定することができます。エクソラログインサーバーはこれらの値を処理せず、受信したJWTの中で返します。

redirect_uri
string

アカウント確認、認証成功、またはパスワードリセット確認後にユーザーをリダイレクトするURLです。このパラメータを設定するには、カスタマーサクセスマネージャーにお問い合わせいただくか、csm@xsolla.comまで電子メールを送信してください。

注意
このパラメータは、プロジェクト設定に複数のリダイレクトURIがある場合に必要です。
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

無効なリクエスト

404

見つかりません

422

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

429

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

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