Account
/login/saml
/login/saml/callback
/login/google
The actual google login route
/login/google/callback
Google login callback
<br> {<br> // The callback code<br> code: string,<br> }<br>
/account
Create a new account
<br> {<br> // The user's username<br> username: string,<br> // The user's email address<br> email: string,<br> // The user's password<br> password: string,<br> // Team name<br> team_name: string,<br> // promotional campaign code (Optional)<br> campaign_code: string,<br> }<br>
/login
Login user
<br> {<br> // The email/username<br> username: string,<br> // The password<br> password: string,<br> }<br>
/logout (authenticated)
Logout user
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
/account/forgotpassword
Do a forgot password thing
This route requires a valid captcha
The captcha client-side response should be passed using the `captchaResponse`
body argument.
<br> {<br> //<br> email: string,<br> // The client-side captcha response<br> captchaResponse: string,<br> }<br>
/account/changepassword/:token
Do a password change
body needs a token + password
This route requires a valid captcha
The captcha client-side response should be passed using the `captchaResponse`
body argument.
<br> {<br> // The new password<br> password: string,<br> // The client-side captcha response<br> captchaResponse: string,<br> }<br>
<br> token: undocumented<br>
/account/requestverification (authenticated)
Start e-mail verification for the logged in user
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
/account/verify/:token
Do account verification
<br> token: undocumented<br>
/account/announcements (authenticated)
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
/account/organisation
Check if organisation eligible for SSO
body needs an email
<br> {<br> // Email<br> email: string,<br> }<br>
/freetrial (authenticated)
Redeem a free trial token
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.