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

Download Open API Spec



Used to login via username, password, and previous authentication receipt.

Field Type Description
username STRING The user's username
password STRING The user's password
authenticationReceipt STRING Optional, but highly recommended. The most recent authentication receipt given to the last success login from this machine, using this client. Having this allows you to bypass throttling on consecutive authentication attempts with a wrong password.