5.4.2 Logout
- Description
-
Discards the authentication information that is used for the current login.
- Execution permissions
-
None.
- API version
-
v1
- Format
-
- Request line
POST /application/component/apiVersion/logout/ httpVersion
- Request header
Cookie:cookie-information
- Request message body
-
None.
- Response header
Set-Cookie:cookie-information
- Response message body
true
- Parameters
-
- Cookie
-
Specify the cookie string.
- Status codes
-
The following table describes the status codes that are returned as a response to the request:
Status code
Message
Description
200
--
The logout succeeded.
- Return values
-
The following information is returned in the response header:
Parameter name
Description
Set-Cookie
Cookie string
- Examples
-
- Example of invoking the logout API
POST http://hostname:xxxxx/im/api/v1/logout HTTP/1.1 Cookie: JSESSIONID=7F2FB43CF4829025661D9E139E911B3B