Logout

Logout

Description¶

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

Request¶

Endpoint¶
/ui/v1/logout
Method¶
POST
Header¶

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
numberOfFailedOneTimePasscodeAttemptsExceeded	*Optional* Value to be false or true
usernameUpdated	*Optional* Value to be false or true
thridpartyReturnURL	*Optional* Return URL

Request Body¶

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

Response¶

{
    "code": "29",
    "type": {
        "name": "SUCCESS"
    },
    "include_i_icon": false,
    "description": "LOGOUT_SUCCESS",
    "parameters": null
}

Updated As Of Version: 6.8.0.0