Elastic.io Roles API
Manage user roles and permissions
Elastic.io Roles API is one of 22 APIs that Elastic.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 3 JSON Schemas.
This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.elastic.io/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic.io Roles API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Bearer token authentication. Obtain a token through the elastic.io platform login or API key.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Manage user roles and permissions
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are JsonApiMeta (4 properties), RoleListResponse (2 properties), RoleResponse (1 property), RoleUpdateRequest (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic.io 12
Other APIs Elastic.io publishes across the network.