Check permissions

Auth

Check whether the current user has the required permissions to use Fleet. Optionally verifies Fleet Server setup privileges.

Query parameters

fleetServerSetup boolean: When true, check Fleet Server setup privileges in addition to standard Fleet privileges

Successful response

application/json

error enum: Values: MISSING_SECURITY MISSING_PRIVILEGES MISSING_FLEET_SERVER_SETUP_PRIVILEGES
success boolean required

Bad Request

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/check-permissions

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/check-permissions" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The current user is missing Fleet privileges

{
  "error": "MISSING_PRIVILEGES",
  "success": false
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}