Skip to content

[POST] Login

/api/login

LoginRequestDTO

Attributes:

Name Type Description
email str

email of the user

password str

password of the user

is_web Optional[bool]

flag to indicate if the request is from the web app

LoginResponseDTO

Attributes:

Name Type Description
project_id int

assigned project id to the user

email str

email of the user

user_id int

unique id of the user

master_account str

flag if user is a master account

profile_picture Union[str, None]

profile picture of the user

project_name str

name of the project

user_type str

UserTypeEnum

token str

generated token for the session

subscription_expiry_date Union[str, None]

date when the subscription of envision monitoring expires in the format of "YYYY-MM-DD"

features Optional[List[str]]

list of features available to the user

Possible Error Codes

  • ACCOUNT_NOT_EXIST - The given email does not exist
  • WRONG_CREDENTIALS - The given password does not match the stored password for the given email address
  • ACCOUNT_LOCKED - Access to the account has been locked by the administrator.