電話番号による認証を開始する

電話番号による認証を開始するClient-side

post/login/phone/request

ユーザー電話番号による認証を開始し、ユーザー電話番号に確認コードを送信します。コードの有効期限は3分です。

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

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

アプリケーションは認証フォームを開き、ユーザーは電話番号を入力することができます。
ユーザーが自分の電話番号を入力します。
アプリケーションは、このリクエストをエクソラログインサーバーに送信します： a. パラメータsend_linkがtrueの場合、このリクエストの後に確認コートを取得するリクエストを送信して、確認コードとリンクを含むSMSを作成する必要があります。 b. パラメータsend_linkがfalseまたは渡されない場合、SMSには確認コードのみが含まれます。
エクソラログインサーバーはSMSを送信し、確認コードのIDを返します。
アプリケーションには、ユーザーが確認コードを入力するためのフィールドが表示されます。
ユーザーは、受け取った確認コードを入力するか、リンクをたどります。
アプリケーションは電話番号による認証を完了するリクエストを受け取ったIDでエクソラログインサーバーに送信します。
ユーザーは認可されたとみなされます。

Request

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. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. 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. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.
with_logout	string Default: "0" 既存のユーザーJWT値を非アクティブ化し、このコールによって生成されたものをアクティブ化するかどうかを示します。次の値を指定できます。 `1` は、既存の値を非アクティブ化し、新しい値をアクティブ化します。 `0` は、既存の値をアクティブ化したままにします。

phone_number required	string^\+(\d){5,25}$ ユーザーの電話番号。
link_url	string <uri> ユーザーをステータス認証ページにリダイレクトするためのURL。パラメータ`send_link`が`true`の場合は、必須です。
send_link	boolean SMSで確認コードと同時にリンクを送信するかどうかを示します。ログインには確認コードの代わりにリンクを使用できます。パラメータの値が`true`の場合、リンクがSMSで送信されます。

Responses

200

404

見つかりません

422

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

429

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

Request samples

application/json

{"link_url": "http://example.com",
"phone_number": "string",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}