AppDirect · OAuth Scopes

AppDirect OAuth Scopes

OAuth 2.0 searched

AppDirect publishes 15 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 AppDirect API on a user’s behalf.

Tokens are issued from https://{marketplaceURL}/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.

CompanyCommerceSubscription CommerceMarketplaceBillingResellerCloud DistributionWebhooksOAuth

Scopes: 15 Flows: authorizationCode, clientCredentials Method: searched

OAuth endpoints

Authorization URL
https://{marketplaceURL}/oauth2/authorize

Token URL
https://{marketplaceURL}/oauth2/token

Flows
authorizationCodeclientCredentials

Scopes (15)

Scope	Description	Flows
ROLE_USER	Allows access as an end user in the company associated with an API call.
ROLE_BILLING_ADMIN	Allows access as a Billing Admin for the company associated with an API call.
ROLE_SYS_ADMIN	Allows access as a Company Admin for the company associated with an API call.
ROLE_RESELLER	Allows access as a Reseller for the company associated with an API call.
ROLE_SALES_SUPPORT	Allows access as a Sales Support agent for the marketplace.
ROLE_CHANNEL_SUPPORT	Allows access as a Customer Support agent for the marketplace.
ROLE_CHANNEL_PRODUCT_SUPPORT	Allows access as a Product Support agent for the marketplace.
ROLE_CHANNEL_ADMIN	Allows access as a Marketplace Manager for the marketplace.
ROLE_CORPORATE_ADMIN	Allows access as a Network Manager for the marketplace.
ROLE_DEVELOPER	Allows access as a Developer for the user associated with an API call.
ROLE_PARTNER_READ	Allows access to read all marketplace data.
ROLE_PARTNER	Allows access to read and write all marketplace data.
openid	Requests that the ID token be returned from the token endpoint for SSO (OIDC).
profile	API client can retrieve user profile information like name (OIDC).
email	API client can retrieve a user's email address (OIDC).

📄 Provider scope reference: https://developer.appdirect.com/user-guides/api-usage/api-auth/scopes

Source

OAuth Scopes

generated: '2026-07-17'
method: searched
source: https://developer.appdirect.com/user-guides/api-usage/api-auth/scopes
docs: https://developer.appdirect.com/user-guides/api-usage/api-auth/scopes
note: >-
  AppDirect OAuth 2.0 scopes correspond to marketplace user roles. Role scopes are
  used with the Authorization Code / Implicit / Password grant types (user-level);
  the ROLE_PARTNER_READ / ROLE_PARTNER scopes are used with the Client Credentials
  grant (system-level). openid/profile/email are OIDC scopes.
schemes:
- name: OAuth2
  source: https://developer.appdirect.com/user-guides/api-usage/api-auth
  flows:
  - flow: authorizationCode
    authorizationUrl: https://{marketplaceURL}/oauth2/authorize
    tokenUrl: https://{marketplaceURL}/oauth2/token
  - flow: clientCredentials
    tokenUrl: https://{marketplaceURL}/oauth2/token
scopes:
- scope: ROLE_USER
  description: Allows access as an end user in the company associated with an API call.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_BILLING_ADMIN
  description: Allows access as a Billing Admin for the company associated with an API call.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_SYS_ADMIN
  description: Allows access as a Company Admin for the company associated with an API call.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_RESELLER
  description: Allows access as a Reseller for the company associated with an API call.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_SALES_SUPPORT
  description: Allows access as a Sales Support agent for the marketplace.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_CHANNEL_SUPPORT
  description: Allows access as a Customer Support agent for the marketplace.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_CHANNEL_PRODUCT_SUPPORT
  description: Allows access as a Product Support agent for the marketplace.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_CHANNEL_ADMIN
  description: Allows access as a Marketplace Manager for the marketplace.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_CORPORATE_ADMIN
  description: Allows access as a Network Manager for the marketplace.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_DEVELOPER
  description: Allows access as a Developer for the user associated with an API call.
  grant_types: [authorizationCode, implicit, password]
- scope: ROLE_PARTNER_READ
  description: Allows access to read all marketplace data.
  grant_types: [clientCredentials]
- scope: ROLE_PARTNER
  description: Allows access to read and write all marketplace data.
  grant_types: [clientCredentials]
- scope: openid
  description: Requests that the ID token be returned from the token endpoint for SSO (OIDC).
  grant_types: [authorizationCode, implicit, password]
- scope: profile
  description: API client can retrieve user profile information like name (OIDC).
  grant_types: [authorizationCode, implicit, password]
- scope: email
  description: API client can retrieve a user's email address (OIDC).
  grant_types: [authorizationCode, implicit, password]