The following operation is supported on this resource:

  • POST - Logout from Space by terminating current client's REST API Session
POST /logout Version 1

This API terminates the user session created by the /api/space/user-management/login API. After the user is logged out, subsequent HTTP session requests to the server will not be granted access, unless, the client provides proper credentials or an X.509 certificate in the request header.

Both the JSESSIONID and JSESSIONIDSSO headers must be passed to the API, in order for the API to locate the user session. This is automatically done by most HTTP Clients.

If the logout is successful, a 200 (Success) Error Code will be returned by the API, along with the response body of:

                        User logged out

If the logout is unsuccessful then, one of these Error Codes will be returned:

  • 401 (Unauthorized) - Incorrect headers were passed in to the API.
  • 412 (Precondition Failed) - Correct headers were passed in, but logout was still unsuccessful.

Sample Usage

POST /logout

Access Control

The following capabilities are required to access this API: DefaultRead