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).

post/api/two-factor/start

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/two-factor/start
  • Auth: API key in header Authorization

Request body

applicationIdstring uuid
codestring
loginIdstring
loginIdTypesstring[]
stateobject
trustChallengestring
userIdstring uuid

Response

Success

codestring
twoFactorIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.