Method: Log out from StoredSafe¶
Description¶
Log out the currently logged in user.
URL Syntax¶
/api/{version}/auth/logout
HTTP Method¶
GET
Successful HTTP Response¶
200
Parameters¶
Parameter name | Description | Parameter type | Type | Mandatory | Comment |
---|---|---|---|---|---|
X-Http-Token | StoredSafe token | HTTP Header | String | 1) | Preferred method |
token | StoredSafe token | URL-parameter | String | 1) | Legacy method |
Note
1) One of the methods is required.
Response Attributes¶
Attribute | Description | Type | Comment |
---|---|---|---|
CALLINFO.errorcodes | Number of errors | Integer | |
CALLINFO.errors | Number of errors | Integer | |
CALLINFO.general | Information | Array | |
CALLINFO.handler | Handler used | String | |
CALLINFO.status | SUCCESS or FAIL | String | |
CALLINFO.token | StoredSafe token to be used in subsequent calls | String | |
CALLINFO.general | Information | Array | |
CALLINFO.logout | “Bye bye” | String | |
DATA | Supplied data in API-call | String | |
PARAMS | PARAMS (empty) | Object |
Examples¶
Logout the logged in user.
Request
GET /api/1.0/auth/logout
x-http-token: your_storedsafe_token
Response
HTTP/2 200
Content-Type: application/json
{
"CALLINFO": {
"logout": "Bye bye",
"errorcodes": 0,
"errors": 0,
"general": [],
"handler": "AuthHandler",
"status": "SUCCESS",
"token": "rotated_storedsafe_token"
},
"DATA": {
"token": "your_storedsafe_token"
},
"HEADERS": {
"Accept": "*/*",
"Host": "safe.domain.cc",
"User-Agent": "curl/7.64.1",
"X-Http-Token": "your_storedsafe_token"
},
"PARAMS": []
}