Get list privileges | Kibana Serverless API

Get list privileges Beta

GET /api/lists/privileges

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Successful response
Hide response attributes Show response attributes object
- is_authenticated boolean Required
- listItems object Required
  
  Additional properties are allowed.
  
  Hide listItems attributes Show listItems attributes object
  
  application object Required
  
  Hide application attribute Show application attribute object
  
  * boolean Additional properties
  
  cluster object Required
  
  Hide cluster attribute Show cluster attribute object
  
  * boolean Additional properties
  
  has_all_requested boolean Required
  
  index object Required
  
  Hide index attribute Show index attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  * boolean Additional properties
  
  username string Required
- lists object Required
  
  Additional properties are allowed.
  
  Hide lists attributes Show lists attributes object
  
  application object Required
  
  Hide application attribute Show application attribute object
  
  * boolean Additional properties
  
  cluster object Required
  
  Hide cluster attribute Show cluster attribute object
  
  * boolean Additional properties
  
  has_all_requested boolean Required
  
  index object Required
  
  Hide index attribute Show index attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  * boolean Additional properties
  
  username string Required
400 application/json; Elastic-Api-Version=2023-10-31

Invalid input data response
One of:
Security_Lists_API_PlatformErrorResponse object Security_Lists_API_SiemErrorResponse object
Hide attributes Show attributes

error string Required

message string Required

statusCode integer Required
Hide attributes Show attributes

message string Required

status_code integer Required
401 application/json; Elastic-Api-Version=2023-10-31

Unsuccessful authentication response
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode integer Required
403 application/json; Elastic-Api-Version=2023-10-31

Not enough privileges response
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode integer Required
500 application/json; Elastic-Api-Version=2023-10-31

Internal server error response
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required

GET /api/lists/privileges

curl \
 -X GET https://<KIBANA_URL>/api/lists/privileges

Response examples (200)

{
  "is_authenticated": true,
  "listItems": {
    "application": {
      "additionalProperty1": true,
      "additionalProperty2": true
    },
    "cluster": {
      "additionalProperty1": true,
      "additionalProperty2": true
    },
    "has_all_requested": true,
    "index": {
      "additionalProperty1": {
        "additionalProperty1": true,
        "additionalProperty2": true
      },
      "additionalProperty2": {
        "additionalProperty1": true,
        "additionalProperty2": true
      }
    },
    "username": "string"
  },
  "lists": {
    "application": {
      "additionalProperty1": true,
      "additionalProperty2": true
    },
    "cluster": {
      "additionalProperty1": true,
      "additionalProperty2": true
    },
    "has_all_requested": true,
    "index": {
      "additionalProperty1": {
        "additionalProperty1": true,
        "additionalProperty2": true
      },
      "additionalProperty2": {
        "additionalProperty1": true,
        "additionalProperty2": true
      }
    },
    "username": "string"
  }
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

{
  "message": "string",
  "status_code": 42
}

Response examples (401)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

Response examples (403)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

Response examples (500)

{
  "message": "string",
  "status_code": 42
}