通过邮箱开始认证

通过邮箱开始认证Client-side

post/login/email/request

通过用户邮箱地址和验证码开始认证并将验证码发送至其邮箱地址。验证码有效期为3分钟。

此调用仅可与通过邮箱完成认证调用一起使用。

使用此调用的工作流如下：

应用程序打开一个认证表单，以便用户可以输入其邮箱地址。
用户输入其邮箱地址。
应用程序将此请求发送给艾克索拉登录管理器服务器： a. 如果参数send_link为true，则在此请求之后，您应该发送获取验证码请求，使邮件包含验证码和链接。 b. 如果参数send_link为false或未传入，则邮件将仅包含验证码。
艾克索拉登录管理器服务器发送邮件并返回验证码的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`，保持现有值的激活状态。

email required	string [ 1 .. 255 ] characters 用户邮箱地址。
link_url	string <uri> 将用户重定向到状态认证页面的URL。如果参数`send_link`为`true`，则为必需。
send_link	boolean 显示发送的验证码邮件中是否包含链接。可以使用链接代替验证码登录。如果参数值为`true`，则链接包含在邮件中发送。

Responses

200

确定

400

错误的请求

404

未找到

422

无法处理的实体

429

请求过多

Request samples

application/json

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

Response samples

application/json

{"operation_id": "string"
}