Retrieve JWT using Login

POST 
/api/v1/login

Web applications should use this API to retrieve JWT and user profile. Subsequent API calls can then use the JWT obtained.

Request JSON

Parameter	Type	Description
email	string	Login email ID
password	string	Login password

API RESPONSE

A JSON with JWT and other user details.

Response with JWT

{
  "user_id": 42,
  "user_email": "user@example.org",
  "username": "John Doe",
  "jwt": "JWT",
  "role_id": 1,
  "role_name": "ADMIN",
  "uploadkey": "ec5139a372f6478d97365ec0df9c9a814",
  "notifications": ["Notification message 1"]
}

Parameter	Type	Description
jwt	string	JSON Web Token. Use this in API calls. See [JWT Authentication] for details.
user_id	string	Login email ID
user_email	string	Login password
username	string	User name as Firstname Lastname
role_id	integer	User role ID
role_name	string	User role name
uploadkey	string	File Uploadkey for use in Picker
notifications	string	List of notification messages since last login

Request

Responses

200

Successful operation

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

500

Internal server error