SFTPGo Octri Preview
POST/user/totp/validate

Validate a one time authentication code

Checks if the given authentication code can be validated using the specified secret and config name

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields
config_namestringoptional
name of the configuration to use to validate the passcode
passcodestringoptional
passcode to validate
secretstringoptional
secret to use to validate the passcode

6 status codes
200successful operation
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.