OpenADR Alliance · OAuth Scopes

OpenADR Alliance OAuth Scopes

OAuth 2.0 derived

OpenADR Alliance publishes 9 OAuth 2.0 scopes via the clientCredentials flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the OpenADR Alliance API on a user’s behalf.

Tokens are issued from auth/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

EnergyUnited StatesUtilitiesElectricityDemand ResponseGridDEROpenADRStandardsSmart GridEV ChargingCertification
Scopes: 9 Flows: clientCredentials Method: derived

OAuth endpoints

Token URL
auth/token
Flows
clientCredentials

Scopes (9)

ScopeDescriptionFlows
read_all VENs and BL can read all resources clientCredentials
read_bl BL can read BL-scoped notifier topic metadata clientCredentials
read_targets VENs may only read objects with targets by providing matching targets clientCredentials
read_ven_objects VENs may only read objects whose clientID matches their own clientCredentials
write_events Only BL can write to events clientCredentials
write_programs Only BL can write to programs clientCredentials
write_reports only VENs can write to reports clientCredentials
write_subscriptions VENs and BL can write to subscriptions clientCredentials
write_vens VENS and BL can write to vens and resources clientCredentials

📄 Provider scope reference:

Source

OAuth Scopes

Raw ↑ 
generated: '2026-07-27'
method: derived
source: openapi/openadr-3-0-0-openapi.yaml, openapi/openadr-3-0-1-openapi.yaml, openapi/openadr-3-1-0-openapi.yaml,
  openapi/openadr-3-1-1-openapi.yaml
schemes:
- name: oAuth2ClientCredentials
  source: openapi/openadr-3-0-0-openapi.yaml
  flows:
  - flow: clientCredentials
    tokenUrl: auth/token
  description: Client credential flow.
- name: oAuth2ClientCredentials
  source: openapi/openadr-3-0-1-openapi.yaml
  flows:
  - flow: clientCredentials
    tokenUrl: auth/token
  description: Client credential flow.
- name: oAuth2ClientCredentials
  source: openapi/openadr-3-1-0-openapi.yaml
  flows:
  - flow: clientCredentials
    tokenUrl: auth/token
  description: Client credential flow.
- name: oAuth2ClientCredentials
  source: openapi/openadr-3-1-1-openapi.yaml
  flows:
  - flow: clientCredentials
    tokenUrl: auth/token
  description: Client credential flow.
scopes:
- scope: read_all
  description: VENs and BL can read all resources
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-0-0-openapi.yaml
  - openapi/openadr-3-0-1-openapi.yaml
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: read_bl
  description: BL can read BL-scoped notifier topic metadata
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: read_targets
  description: VENs may only read objects with targets by providing matching targets
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: read_ven_objects
  description: VENs may only read objects whose clientID matches their own
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: write_events
  description: Only BL can write to events
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-0-0-openapi.yaml
  - openapi/openadr-3-0-1-openapi.yaml
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: write_programs
  description: Only BL can write to programs
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-0-0-openapi.yaml
  - openapi/openadr-3-0-1-openapi.yaml
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: write_reports
  description: only VENs can write to reports
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-0-0-openapi.yaml
  - openapi/openadr-3-0-1-openapi.yaml
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: write_subscriptions
  description: VENs and BL can write to subscriptions
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-0-0-openapi.yaml
  - openapi/openadr-3-0-1-openapi.yaml
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml
- scope: write_vens
  description: VENS and BL can write to vens and resources
  flows:
  - clientCredentials
  sources:
  - openapi/openadr-3-0-0-openapi.yaml
  - openapi/openadr-3-0-1-openapi.yaml
  - openapi/openadr-3-1-0-openapi.yaml
  - openapi/openadr-3-1-1-openapi.yaml