Lunar Energy · OAuth Scopes

Lunar Energy OAuth Scopes

OAuth 2.0 derived

Lunar Energy publishes 4 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the Lunar Energy API on a user’s behalf.

Tokens are issued from https://lunar-customer-prod-us-west-1.auth.us-west-1.amazoncognito.com/oauth2/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.

EnergyHome BatterySolarVirtual Power PlantDERMSDistributed Energy ResourcesGrid ServicesDemand ResponseStorageInverterSmart HomeEnergy ManagementTariffsTelemetryVPPFlex Events
Scopes: 4 Flows: authorizationCode Method: derived

OAuth endpoints

Authorization URL
https://lunar-customer-prod-us-west-1.auth.us-west-1.amazoncognito.com/oauth2/authorize
Token URL
https://lunar-customer-prod-us-west-1.auth.us-west-1.amazoncognito.com/oauth2/token
Flows
authorizationCode

Scopes (4)

ScopeDescriptionFlows
lunar/device.read Read device metadata and telemetry (excluding plans) authorizationCode
lunar/device.write Modify devices including operation mode authorizationCode
lunar/plan.read Read existing device plans authorizationCode
lunar/plan.write Send plans to a device authorizationCode

Source

OAuth Scopes

lunar-energy-scopes.yml Raw ↑
generated: '2026-07-11'
method: derived
source: openapi/gridshare-customer-api-openapi.yml
schemes:
- name: bearerAuth
  source: openapi/gridshare-customer-api-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: https://lunar-customer-prod-us-west-1.auth.us-west-1.amazoncognito.com/oauth2/authorize
    tokenUrl: https://lunar-customer-prod-us-west-1.auth.us-west-1.amazoncognito.com/oauth2/token
  description: |-
    OAuth 2.0 Authorization Code flow against the lunar-customer
    Amazon Cognito user pool.
scopes:
- scope: lunar/device.read
  description: Read device metadata and telemetry (excluding plans)
  flows:
  - authorizationCode
  sources:
  - openapi/gridshare-customer-api-openapi.yml
- scope: lunar/device.write
  description: Modify devices including operation mode
  flows:
  - authorizationCode
  sources:
  - openapi/gridshare-customer-api-openapi.yml
- scope: lunar/plan.read
  description: Read existing device plans
  flows:
  - authorizationCode
  sources:
  - openapi/gridshare-customer-api-openapi.yml
- scope: lunar/plan.write
  description: Send plans to a device
  flows:
  - authorizationCode
  sources:
  - openapi/gridshare-customer-api-openapi.yml