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

Download Open API Spec

ChangePasswordWithTwoFactorAuthToken

org.sagebionetworks.repo.model.auth.ChangePasswordWithTwoFactorAuthToken

Used to change the user password when two factor authentication is enabled. The twoFaToken is generated by the server and included in the 401 response the user tries to update the password with either the old password or a token. Only TOTP and RECOVERY_CODE otp codes can be used for this operation.

Field Type Description
newPassword STRING The new password
concreteType STRING Indicates which implementation of PasswordChangeInterface this object represents. Valid Values: org.sagebionetworks.repo.model.auth.ChangePasswordWithToken org.sagebionetworks.repo.model.auth.ChangePasswordWithCurrentPassword
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.