Destroys any authentication cookies associated with the current session for a tenant logging out.
Since this operation ends the user's session with the Akana API Platform, there is no response content.
Note: we recommend using the GET /api/login/endsession operation, rather than this operation which will be deprecated.
Authorization Roles/Permissions: User (logged in).
This topic includes the following sections:
The example below logs the user out.
Sample request URL
Sample request headers
For general information on request header values, refer to HTTP Request Headers.
application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Note: Although this operation doesn't include any content in the response, the Accept header is required for forward compatibility with future versions.
|Parameter||Parm Type||Data Type||Required||Description|
|fedmemberId||Path||string||Optional||The unique ID for a specific federation member. Required for federation scenarios, otherwise optional.|
If successful, this operation returns HTTP status code 200. There is no response body since this operation ends the user's session.
The sample response below shows that the logout completed successfully. The new set-cookie parameter expires the current cookie, effectively ending the user's Akana API Platform session.
Sample response header
HTTP/1.1 200 OK Date: Wed, 06 Feb 2013 20:30:27 GMT Set-Cookie: AtmoAuthToken=none;path=/;expires=Wed, 06-Feb-2013 15:30:27 GMT;HttpOnly;Version=1
Sample response body
For general information on response header values, refer to HTTP Response Headers.
|Content-Type||application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json|
|Set-Cookie||The set-cookie response header sets, updates, or expires the platform cookie to reflect changes made by the operation. In this case, it expires the browser cookie.|
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
|500||An error occurred processing the call.|