Opal · OAuth Scopes

Opal OAuth Scopes

OAuth 2.0 derived

Opal publishes 2 OAuth 2.0 scopes via the authorizationCode and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Opal API on a user’s behalf.

Tokens are issued from /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.

CompanyConsumerMarketingContent PlanningMarketing CalendarCampaign ManagementCollaborationSaaSContent MarketingEditorial CalendarWorkflowApprovalsDigital Asset ManagementJSON:APIOAuth 2.0OpenAPI

Scopes: 2 Flows: authorizationCode, clientCredentials Method: derived

OAuth endpoints

Authorization URL
/oauth2/auth

Token URL
/oauth2/token /oauth/token

Flows
authorizationCodeclientCredentials

Scopes (2)

Scope	Description	Flows
offline_access	Include this scope if you wish to receive a refresh token	authorizationCode
write:onboarding	Include this scope if you wish to make API requests to onboard new Opals.	clientCredentials

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-08-13'
method: derived
source: openapi/opal-v2-openapi.yml, openapi/opal-v3-openapi.yml
schemes:
- name: oauth2
  source: openapi/opal-v2-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: /oauth2/auth
    tokenUrl: /oauth2/token
  description: This API uses OAuth 2.0 with the authorization code grant flow. You can find
    more detailed authentication instructions in the [Authentication Strategies](/api/documentation#section/Authentication-Strategies/OAuth-2.0)
    section.
- name: oauth2
  source: openapi/opal-v3-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: /oauth2/auth
    tokenUrl: /oauth2/token
  description: |-
    This API uses OAuth 2.0 with the authorization code grant flow. You can
    find more detailed authentication instructions in the [Authentication
    Strategies](/api/documentation#section/Authentication-Strategies/OAuth-2.0)
    section.
- name: anonymous_oauth
  source: openapi/opal-v3-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: /oauth/token
  description: |-
    The OAuth 2.0 client credentials flow is used for secure server-server
    requests when Opal does not need to associate a request with a particular
    Opal user. These anonymous requests are instead authorized based on the
    OAuth scope.
scopes:
- scope: offline_access
  description: Include this scope if you wish to receive a refresh token
  flows:
  - authorizationCode
  sources:
  - openapi/opal-v2-openapi.yml
  - openapi/opal-v3-openapi.yml
- scope: write:onboarding
  description: Include this scope if you wish to make API requests to onboard new Opals.
  flows:
  - clientCredentials
  sources:
  - openapi/opal-v3-openapi.yml