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.

« Disable elevated permissions Login to ECE »

› › › ›

Enable elevated permissions

edit

Enable elevated permissions

edit

Enables the elevated permissions for the current user. Elevated permissions allow the user to complete potentially destructive operations on clusters. Elevated permissions are available for a limited period of time and automatically expire if you do not renew them.

Request

edit

POST /api/v1/users/auth/_elevate

Request body

edit

(ElevatePermissionsRequest) The request for elevated permissions

Responses

edit

200

(TokenResponse) Elevated permissions are enabled and the authorization token was generated.

400

(BasicFailedReply) Missed or invalid MFA token. (code: authc.invalid_token)

Headers

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

401

(BasicFailedReply) The authentication token is invalid or expired. (code: root.unauthorized)

Headers

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

501

(BasicFailedReply) You need 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/_elevate \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "token" : "string"
}
'

« Disable elevated permissions Login to ECE »