Sessions

>>>

POST /api/v2/users/sign_in
Sign in user

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
email
required

Validations:

  • Must be a String
password
required

Validations:

  • Must be a String

Examples

// Unauthorized
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
401
{
  "error": "Log in failed. If you have Single Sign-on enabled on your account, please use it to log in."
}
// Unauthorized
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "wordpass"
}
401
{
  "error": "Log in failed. If you have Single Sign-on enabled on your account, please use it to log in."
}
// Missing "email" parameter
POST /api/v2/users/sign_in
{
  "password": "wordpass"
}
422
{
  "error": "Missing parameter email"
}
// Missing "password" parameter
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com"
}
422
{
  "error": "Missing parameter password"
}
// If user has SSO provider set
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
400
{
  "error": "Log in failed. If you have Single Sign-on enabled on your account, please use it to log in."
}
// When user is not confirmed
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
401
{
  "error": "Log in failed. If you have Single Sign-on enabled on your account, please use it to log in."
}
// Successful request
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
200
{
  "ok": "Logged in successfully"
}
// Successful request
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
200
{
  "ok": "Logged in successfully"
}
// Successful request
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
200
{
  "ok": "Logged in successfully"
}
// Successful request
POST /api/v2/users/sign_in
{
  "email": "johndoe@gmail.com",
  "password": "password"
}
200
{
  "ok": "Logged in successfully"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/users/sign_in/google
Sign in user with Google

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
token
required

Validations:

  • Must be a String

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/users/sign_in/azure
Sign in user with Azure

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
token
required

Validations:

  • Must be a String

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

DELETE /api/v2/users/sign_out
Sign out user

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters