The Open API specification for Synapse is now available for download!

Download Open API Spec



Used to login when two factor authentication is enabled.

Field Type Description
userId INTEGER The id of the user that attempted to authenticate.
twoFaToken STRING The token that was included in the error response when authenticating.
otpCode STRING One time password (e.g. generated by the authenticator application, depending on the otpType value)
otpType TwoFactorAuthOtpType The type of one time password code that can be used to authenticate through two factor authentication.