initiateEmail (v1)

Initiate time-based one-time password email challenge

Query POST tag:Challenge

Overview

Initiates time-based one-time password email challenge.

This will initiate a time-based one-time password (TOTP) sent as an e-mail to the user’s e-mail address to authorise an operation request.

Once the TOTP is verified, using the ‘Verify’ endpoint, user will be able to proceed with unauthorised operation.

POST (/internal/v1/mfa/totp-email/{challengeId}:initiate)

Parameters

  • challengeId (path) (required): The ID is challenge id received during operation initiation which required challenge.

Responses

400 Bad Request

500 Internal Server Error

Architecture

7 properties
code string
Allowed values: urn:plmr:mfa-totp:api:INTERNAL_SERVER_ERROR urn:plmr:mfa-totp:api:BAD_REQUEST urn:plmr:mfa-totp:api:RESOURCE_UNKNOWN urn:plmr:mfa-totp:api:UNAUTHORIZED urn:plmr:mfa-totp:api:FORBIDDEN urn:plmr:mfa-totp:api:USER_NOT_FOUND urn:plmr:mfa-totp:api:CHALLENGE_NOT_FOUND urn:plmr:mfa-totp:api:INVALID_OTP urn:plmr:mfa-totp:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa-totp:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa-totp:api:INTERNAL_SERVER_ERROR urn:plmr:mfa-totp:api:BAD_REQUEST urn:plmr:mfa-totp:api:RESOURCE_UNKNOWN urn:plmr:mfa-totp:api:UNAUTHORIZED urn:plmr:mfa-totp:api:FORBIDDEN urn:plmr:mfa-totp:api:USER_NOT_FOUND urn:plmr:mfa-totp:api:CHALLENGE_NOT_FOUND urn:plmr:mfa-totp:api:INVALID_OTP urn:plmr:mfa-totp:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa-totp:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND
message string
requestId string
fieldErrors array [object]