Auth TOTP

Verify TOTP

post

Verify TOTP code and complete the login process. This endpoint is used after initial login when TOTP is required.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

temp_tokenstringRequired

Temporary token received from initial login

Example: eyJ0eXA...

tokenstringRequired

TOTP verification code

Example: 123456

Responses

200

The TOTP verification was successful and login is completed.

application/json

keystringOptional

Login token

Example: a46ba...

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

403

Forbidden

post/api/v1/auth/totp/verify/

HTTPcURLJavaScriptPython

POST /api/v1/auth/totp/verify/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "temp_token": "eyJ0eXA...",
  "token": "123456"
}

{
  "key": "a46ba..."
}

Setup TOTP

post

Setup TOTP authentication.

Authorizations

Token

AuthorizationstringRequired

Responses

201

The TOTP setup was successful.

application/json

secret_keystringOptional

TOTP secret key

Example: RE4U7XXXXXXXXXXXX

provisioning_uristringOptional

TOTP provisioning URI

Example: otpauth://totp/Omnitron%3Aakinon?secret=RE4U7XXXXXXXXXXXX&algorithm=SHA1&digits=6&period=30&issuer=Omnitron

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

post/api/v1/auth/totp/setup/

HTTPcURLJavaScriptPython

POST /api/v1/auth/totp/setup/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "secret_key": "RE4U7XXXXXXXXXXXX",
  "provisioning_uri": "otpauth://totp/Omnitron%3Aakinon?secret=RE4U7XXXXXXXXXXXX&algorithm=SHA1&digits=6&period=30&issuer=Omnitron"
}

Activate TOTP

post

Activate TOTP authentication by verifying the TOTP code.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

tokenstringRequired

TOTP verification code

Example: 123456

Responses

200

The TOTP activation was successful.

application/json

recovery_codesstring[]Optional

Recovery codes

Example: ABCD1234

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

post/api/v1/auth/totp/activate/

HTTPcURLJavaScriptPython

POST /api/v1/auth/totp/activate/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "token": "123456"
}

{
  "recovery_codes": [
    "ABCD1234"
  ]
}

Deactivate TOTP

post

Deactivate TOTP authentication for the current user.

Authorizations

Token

AuthorizationstringRequired

Responses

200

The TOTP deactivation was successful.

No content

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

post/api/v1/auth/totp/deactivate/

HTTPcURLJavaScriptPython

POST /api/v1/auth/totp/deactivate/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content