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: 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",
    "timeout": false
}

Response

{
    "code": "29",
    "type": {
        "value": "Success",
        "name": "SUCCESS"
    },
    "text": null,
    "include_i_icon": false,
    "description": "You have logged out successfully."
}