Authenticating with MFA Factor
    • PDF

    Authenticating with MFA Factor

    • PDF

    Article summary

    Perform Step Up Authentication using the MFA factor

    This POST method is used to perform step-up authentication using the MFA factor.

    POST

    {{url}}/api/step-up/authenticate/{{factor}}

    Request Parameter

    Parameter

    Description

    Data Type

    Required

    factor

    Indicates the MFA factor used for Step Up Verification.
    Values: TOTP and WEB_AUTHN

    String

    Mandatory

    Request Example of TOTP

    curl --location '{{url}}/api/step-up/authenticate/TOTP' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --data '{
        "otp": "858521"
    }

    Response Example of TOTP

    {
        "result": "SUCCEEDED"
    }

    Request and Response Example of WebAuthn

    Request example of WebAuthn authentication start

    curl --location '{{url}}/api/step-up/authenticate/WEB_AUTHN' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --data '{
      "action": "START_AUTHN"
    }'

    Response body of WebAuthn authentication start

    {
      "result": "CHALLENGE",
      "additionalDetails": {
        "requestOptionsId": "<unique identifier of the authentication challenge>",
        "requestOptionsJson": "<WebAuthn authentication challenge as JSON string>"
      }
    }

    Request example of the WebAuthn authentication completion

    curl --location '{{url}}/api/step-up/authenticate/WEB_AUTHN' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --data '{
      "action": "FINISH_AUTHN",
      "requestOptionsId": "<unique identifier of the authentication challenge>",
      "publicKeyCredentialJson": "<the WebAuthn credential to verify/authenticate with>"
    }

    Response body WebAuthn authentication completion

    {
      "result": "SUCCEEDED" or "FAILED"
    }


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.