Resources

POST  /users/sign_in

Authenticate to retrieve secure token to carry out authed requests.

Note

Upon successful authentication, the authentication token will be located in the headers of the response.

Note

If you have 2FA set up for your account, you'll need to call this resource twice. Once for initial login and once for 2FA confirmation.

Headers

Content-Type [Required]
application/json
Yes
All API requests must have Content-Type declared.

Body

email [Required]
string
Yes
The email you use to authenticate.
password [Required]
string
Yes
The password you use to authenticate.
mfa_code
string
No
Required if enable_mfa is set for your account. This is used to send the code you receive via email.

Response

Success
{"success":"You are now authenticated. Please check the response headers for your authorization key."}
No Account
{"error":"Could not find an account with those details. Please try again."}
Account Locked
{"error":"Your account is currently locked. Please reset your password."}
Account Becomes Locked
{"error":"Your account is now locked. Please reset your password."}
Account Inactive
{"error":"Your account is not active. Please speak to the Rampage Team to resolve."}
Incorrect Password Specified
{"error":"Incorrect login details specified. You have {x} attempts left."}

Response

Success
{"success":"Please call POST \/users\/sign_in with credentials and correct 2FA to complete authentication.","mfa_required":true}
2fa Not Setup
{"error":"2FA is not enabled. Please login without supplying a 2FA code."}
Incorrect 2fa Submitted
{"error":"Incorrect 2FA code specified. You have {x} attempts left."}
Account Becomes Locked 2fa
{"error":"Your account is now locked. Please reset your password."}