Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Current »

Method description

A simple login service method to check if the login and password credentials are valid. This should return an authorization matrix if the login is successful.

Request Data

{
	"email": "email@email.com",
	"password": "password"
}
NameTypeOptionalDescription
emailstringfalseuser's email who wants to log in
passwordstringfalseuser password

Response format and codes

HTTP codedescription
200successful login
401invalid login credentials


On successful login, the service should return a response similar to this:

{
	"user_token": "user_api_token"
}


On a failed login attempt the response is like the following example:

{
  "err": "invalid.login.credentials"
}
  • No labels