It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Login to ECE Refresh authentication token »

› › › ›

Logout from ECE

edit

Logout from ECE

edit

Destroys the current session.

Request

edit

POST /api/v1/users/auth/_logout

Headers

edit

Name	Type	Required	Description
`Cookie`	`string`	N	Cookie header containing the ec-sso-session-id session cookie.

Responses

edit

200

(EmptyResponse) The current session was successfully destroyed.

501

(BasicFailedReply) The administrator needs to configure the authentication cluster. (code: authc.no_authentication_cluster)

Headers

x-cloud-error-codes (string; allowed values: [authc.no_authentication_cluster]): The error codes associated with the response

502

(BasicFailedReply) The authentication cluster failed to process the request. The response body contains details about the error. (code: authc.authentication_cluster_error)

Headers

x-cloud-error-codes (string; allowed values: [authc.authentication_cluster_error]): The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/users/auth/_logout \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H Cookie: string

« Login to ECE Refresh authentication token »