GET /oauth/login/logout

Destroys any authentication cookies associated with the current OAuth session.

Once the API calls are made, the logout API removes the OAuthToken cookie and forces users to log in again before invoking any protected API calls.

Authorization Roles/Permissions: Anyone can run this operation.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{oauth-provider-url}/oauth/login/logout

Back to top

Sample Request

The example below shows a request to log out.

Request URL

https://{oauth-provider-url}/oauth/login/logout

Sample request headers

Accept: application/json

Sample request body

None.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json

Back to top

Request Parameters

None.

Back to top

Response

If successful, this operation returns HTTP status code 200. The OAuthToken cookie is removed. The response payload is empty.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Content-Type: application/json

Sample response body: application/json

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json

Back to top

Response Body

The response payload is empty.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
500 An error occurred processing the call.

More information about Enterprise API Platform API error messages.

Back to top

Related Topics