start Two Factor Login With Id
POST {{baseUrl}}/api/two-factor/start
Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code. This API is intended to allow you to begin a Two-Factor login outside a normal login that originated from the Login API (/api/login).
Request Body
{"applicationId"=>"<uuid>", "code"=>"<string>", "loginId"=>"<string>", "trustChallenge"=>"<string>", "userId"=>"<uuid>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"code":"\u003cstring\u003e","methods":[{"authenticator":{"algorithm":"HmacSHA1","codeLength":"\u003cinteger\u003e","timeStep":"\u003cinteger\u003e"},"email":"\u003cstring\u003e","id":"\u003cstring\u003e","lastUsed":"\u003cboolean\u003e","method":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","secret":"\u003cstring\u003e"},{"authenticator":{"algorithm":"HmacSHA256","codeLength":"\u003cinteger\u003e","timeStep":"\u003cinteger\u003e"},"email":"\u003cstring\u003e","id":"\u003cstring\u003e","lastUsed":"\u003cboolean\u003e","method":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","secret":"\u003cstring\u003e"}],"twoFactorId":"\u003cstring\u003e"}