TOTP

Used to interact with One Time Password authenticators of the current user.

Create TOTP

Initializes TOTP by generating a new secret. This then needs to be added to an authenticator app and verified. A user can have only one TOTP secret and this endpoint will return an error if it is already present.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Responses
200

Returns the response for Session wrapped TOTP object.

400

Request was not successful

403

Request was not successful

500

Request was not successful

post/v1/me/totp
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete TOTP

Deletes the current TOTP secret. This will invalidate all authenticators that where previously added.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Responses
200

Returns a deleted TOTP.

404

Request was not successful

500

Request was not successful

delete/v1/me/totp
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Attempt TOTP Verification

Attempts to verify the TOTP secret previously created using a code from an authenticator.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
Request Body schema: application/x-www-form-urlencoded
code
string
Responses
200

Returns the response for Session wrapped TOTP object.

400

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

500

Request was not successful

post/v1/me/totp/attempt_verification
Request samples
application/x-www-form-urlencoded
code=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}