Kibana roles API
Manage the roles that grant Elasticsearch and Kibana privileges.
Kibana roles API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 5 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Kibana roles API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiKeyAuth— These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Manage the roles that grant Elasticsearch and Kibana privileges.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Kibana_HTTP_APIs_security_role_remote_indices_privileges (6 properties), Kibana_HTTP_APIs_security_role_indices_privileges (5 properties), Kibana_HTTP_APIs_security_role_elasticsearch (5 properties), Kibana_HTTP_APIs_security_role_put_payload (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kibana 12
Other APIs Kibana publishes across the network.