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.

« Create API key Get all API keys for all users »

› › › ›

Delete API keys of multiple users

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete API keys of multiple users

edit

Delete or invalidate the API keys for multiple users.

Request

edit

DELETE /api/v1/users/auth/keys/_all

Request body

edit

(DeleteUsersApiKeysRequest) (required) The request to delete API keys.

Responses

edit

200

(EmptyResponse) The API keys are deleted.

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): 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 -XDELETE https://{{hostname}}/api/v1/users/auth/keys/_all \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "user_api_keys" : [
      {
         "api_key_id" : "string",
         "user_id" : "string"
      }
   ]
}
'

« Create API key Get all API keys for all users »