Query Kibana roles with optional filters, paging, and sorting.

post/api/security/role/_query

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/security/role/_query
  • Auth
    • API key in header Authorization
    • or HTTP basic

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

fromnumber
querystring
sizenumber

Response

Indicates a successful call.

countnumber required

The number of roles returned in this response page.

totalnumber required

The total number of roles that match the query.

Changes