Enable elevated permissions

This endpoint is deprecated and scheduled to be removed in the next major version. Sudo has been retired

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)

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

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 »