Login

Description

The login endpoint is used to log a user into the VELA application.

Request

Endpoint

/ui/v1/login

Method

POST
Content-Type: application/json
Authorization: Basic $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body

{
    "userName": "johnsmith",
    "password": "Password1!"
}

Response

{
  "message": {
    "code": "28",
    "type": {
      "value": "Success",
      "name": "SUCCESS"
    },
    "text": null,
    "include_i_icon": false,
    "description": "You have been successfully authenticated."
  },
  "locationPath": "loyaltyRewardsUserEnrollment",
  "userId": 3,
  "applicationId": 1,
  "userRoles": "CUSTOMER_USER",
  "forceChangePasswordInd": false,
  "userLocale": "en_US",
  "passwordExpiryDaysIn": -1,
  "securityQuestionsEnrolledInd": true,
  "userEmail": "vela@datumsoftware.com",
  "mobile": null,
  "loyaltyStatus": {
    "value": "Not Enrolled",
    "name": "NOT_ENROLLED"
  },
  "loyaltyRewardsNumber": null,
  "uiType": null,
  "createdUserId": 1,
  "unpaidInvoiceCount": null
}