How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenADR Alliance Auth API

The Auth API from OpenADR Alliance — 2 operation(s) for auth.

OpenADR Alliance Auth API is one of 9 APIs that OpenADR Alliance publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.

This API exposes 3 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: http://localhost:8081/openadr3, http://localhost:8081/openadr3/3.0.1, https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0.

3 operations 2 paths 10 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
http://localhost:8081/openadr3
http://localhost:8081/openadr3/3.0.1
https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0
Authentication
OAuth 2.0, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

OpenADR Alliance Auth API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 6 scopes. It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • oAuth2ClientCredentials — Client credential flow.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 3
GET
/auth/token
fetch a token
fetchToken 2 params → 200400403500
POST
/auth/token
fetch a token
fetchToken body → 200400403500
GET
/auth/server
fetch server info
getAuthServerInfo → 200500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are problem (5 properties), clientCredentialResponse_2 (5 properties), clientCredentialResponse (5 properties), problem_2 (5 properties). Each schema is shown below with its type and property counts.

problem
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
authError
object
error reponse on HTTP 400 from auth/token per https://www.rfc-editor.org/rfc/rfc6749
3 properties 1 required
clientCredentialResponse
object
Body response from /auth/token. Note snake case per https://www.rfc-editor.org/rfc/rfc6749
5 properties 2 required
clientCredentialRequest
object
Body of POST request to /auth/token. Note snake case per https://www.rfc-editor.org/rfc/rfc6749
4 properties 3 required
clientCredentialResponse_2
object
Body response from /auth/token. Note snake case per https://www.rfc-editor.org/rfc/rfc6749
5 properties 2 required
problem_2
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
authServerInfo
object
1 property 1 required
clientCredentialResponse_3
object
Body response from /auth/token. Note snake case per https://www.rfc-editor.org/rfc/rfc6749
5 properties 2 required
problem_3
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
authError_2
object
error response on HTTP 400 from auth/token per https://www.rfc-editor.org/rfc/rfc6749
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openadr-alliance-auth-api-openapi.yml Raw ↑

Other APIs OpenADR Alliance publishes across the network.

OpenADR Alliance Events API
OpenADR Alliance MQTT Notifier API
OpenADR Alliance Notifiers API
OpenADR Alliance Programs API
OpenADR Alliance Reports API
OpenADR Alliance Resources API
OpenADR Alliance Subscriptions API
OpenADR Alliance Vens API
Where this information came from

This is an independent, third-party profile of OpenADR Alliance Auth API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.