Login

  • Auth
  • POST Login

User/Password Login

This method allows you to set login login for your application via username and password.

Resource

  • Production environment: https://auth.altravia.com/login/
  • Testing environment: https://test.auth.altravia.com/login/

Parameters

Property name Type Description
username string Email of the user who intends to login.
password string Password of the user who intends to login; minimum 8 characters of which at least one is a number.

Request examples

Response

Response Format

If successful, the response header HTTP status code will be 200 OK and the request will be answered.

If you try to get a request without authorization, you will receive an error 401 Unauthorized.

Additionally you should also handle the 400 Bad request status. For more info on HTTP status handling see dedicated section in Integration best practices page.

Request Response

Parameter Type Description
success boolean True or false.
user UserResponseDetails Object that represents the user who logged in.
privileges array Array of user privileges in relation to the domain in which you are logged in.
domain string Domain name for which you are logged in.
last_access string Last user login date.
token string Alpha-numeric string to re-login and stay in session.
expire string Date of obsolescence of the token.
message string Contains error or success messages.
error int Contains the encoding of the error or NULL if successful.

User Response Details

Parameter Type Description
id_user string Unique identifier of the user.
username string User login mail.
name string User name.
surname string User surname.
cell string User's phone.
timestamp_creation string User creation date.
timestamp_last_access string Last user login date.
privileges_list array Array of user privileges in relation to the domain in which you are logged in.
profile_image string Path to the image associated with the user profile.