Authentication:Logout

Search (SHIFT+S)

Logout

GET /logout

The user after completing the needed calls can call '/logout' API to log himself out. User needs to pass in the token passed in the request header. The call will terminate the session and the passed token will be invalidated, and the user gets logged out. (This decrements the token count by 1)

Query Parameters

force	The user with exceeded tokens limit can still call '/logout?force=true' . This will delete all the current logged in session for the user and invalidates all the tokens, (All the tokens are deleted for the user) Default value: false
username	A system administrator ( root ) user can log-out the logged in management-user calling '/logout?username=[USER_ID]'. (In an event of a user exceeded it's token limits, a sysadmin user can logout the user)

Required Roles

This call has no restrictions.

Response Body

Response

Examples

Request

GET https://192.168.0.0:4443/logout HTTP/1.1 

Content-Type: application/xml 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK 
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<LoggedOut>
  <user>root</user>
</LoggedOut>

Request

GET https://192.168.0.0:4443/logout.json HTTP/1.1  

Content-Type: application/json 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK 
Content-Type: application/json 

{
   "user" : "root"
}

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/logout

Response

HTTP/1.1 200 OK 
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<LoggedOut>
  <user>root</user>
</LoggedOut>