Returns user privileges for the Kibana space

Base URL: https://{kibana_url}

GET /api/detection_engine/privileges

Auth

Retrieves whether or not the user is authenticated, and the user's Kibana space and index privileges, which determine if the user can create an index for the Elastic Security alerts generated by detection engine rules.

Responses

Successful response

application/json

has_encryption_key boolean required
is_authenticated boolean required

Unsuccessful authentication response

application/json

error string required
message string required
statusCode integer required

Internal server error response

application/json

message string required
status_code integer required

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/detection_engine/privileges

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/detection_engine/privileges" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "application": {},
  "cluster": {
    "all": true,
    "manage": true,
    "manage_api_key": true,
    "manage_index_templates": true,
    "manage_ml": true,
    "manage_own_api_key": true,
    "manage_pipeline": true,
    "manage_security": true,
    "manage_transform": true,
    "monitor": true,
    "monitor_ml": true,
    "monitor_transform": true
  },
  "has_all_requested": true,
  "has_encryption_key": true,
  "index": {
    ".alerts-security.alerts-default": {
      "all": true,
      "create": true,
      "create_doc": true,
      "create_index": true,
      "delete": true,
      "delete_index": true,
      "index": true,
      "maintenance": true,
      "manage": true,
      "monitor": true,
      "read": true,
      "view_index_metadata": true,
      "write": true
    }
  },
  "is_authenticated": true,
  "username": "elastic"
}

{
  "error": "Unauthorized",
  "message": "[security_exception\n\tRoot causes:\n\t\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "message": "Internal Server Error",
  "status_code": 500
}