Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic.io Auth Clients API

Manage OAuth authentication clients

Elastic.io Auth Clients 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 Auth Clients. 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 9 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.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Server
https://api.elastic.io/v2
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Elastic.io Auth Clients 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.

Auth Clients 5

Manage OAuth authentication clients

GET
/auth-clients
Elastic.io List auth clients
listAuthClients 2 params → 200401
POST
/auth-clients
Elastic.io Create an auth client
createAuthClient body → 201401
GET
/auth-clients/{auth_client_id}
Elastic.io Get an auth client
getAuthClient 1 param → 200401404
PATCH
/auth-clients/{auth_client_id}
Elastic.io Update an auth client
updateAuthClient 1 param body → 200401404
DELETE
/auth-clients/{auth_client_id}
Elastic.io Delete an auth client
deleteAuthClient 1 param → 204401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are JsonApiLinks (5 properties), JsonApiMeta (4 properties), AuthClient (4 properties), AuthClientListResponse (3 properties). Each schema is shown below with its type and property counts.

AuthClientListResponse
object
3 properties
ErrorResponse
object
1 property
AuthClientCreateRequest
object
1 property 1 required
JsonApiMeta
object
4 properties
AuthClientResponse
object
1 property
JsonApiLinks
object
5 properties
AuthClient
object
4 properties
AuthClientUpdateRequest
object
1 property 1 required
JsonApiRelationship
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-io-auth-clients-api-openapi.yml Raw ↑

Other APIs Elastic.io publishes across the network.

Elastic.io Agents API
Elastic.io Auth Secrets API
Elastic.io Components API
Elastic.io Contracts API
Elastic.io Credentials API
Elastic.io Data Samples API
Elastic.io Executions API
Elastic.io Flow Drafts API
Elastic.io Flow Versions API
Elastic.io Flows API
Elastic.io Logs API
Elastic.io Quota Usages API