Logout

Description

The logout endpoint is used to log a user out of the VELA application.

Request

Endpoint

/ui/v1/logout

Method

POST

Content-Type: application/json
Authorization: $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: dXNlcm5hbWU6cGFzc3dvcmQ=

Attributes

ELEMENT DESCRIPTION
Username Required

Username
timeout Required

Value to be false or true

Request Body

{
    "userName": "johnsmith",
    "timeout": false
}

Response


{
    "code": "29",
    "type": {
        "value": "Success",
        "name": "SUCCESS"
    },
    "text": null,
    "include_i_icon": false,
    "description": "You have been logged out successfully. <strong>For your security, we recommend you close your browser to finalize your session.</strong> You can log in again."
}

Updated As Of Version: 3.3.0.5