Logout
Description¶
The logout endpoint is used to log a user out of the VELA application.
Request¶
Endpoint¶
/ui/v1/logoutMethod¶
POSTHeader¶
Content-Type: application/json
Authorization: Digest nonce="0cada2c21ae94896", nl="16", token="480771ff499c028178f560e395bb0d21"
Header Attributes
| ELEMENT | DESCRIPTION | FORMAT |
|---|---|---|
| Content-Type | Required Specifies the media type of the request body. |
application/json |
| Authorization | Required Authentication information used to authorize the request. The Digest authorization header contains the nonce, nonce length (nl), and token. |
Digest nonce="{nonce}", nl="{nonceLength}", token="{token}" |
| • nonce | Required Unique value used as part of the request authentication. |
e.g., 0bafa2c21ae94792 |
| • nl | Required Nonce Length. Specifies the length of the nonce value. |
e.g., 19 |
| • token | Required token is the MD5 of (Merchant Code : Secret : DATE in UTC : Nonce : Nonce Length). |
MD5 hash |
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 |
| thirdpartyReturnURL | Conditional Required if SSO is enabled 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: 7.2.x