Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Used by API Credentials and How to authenticate with a Vonage Contact Center API (using the new API gateway) 


Excerpt

Scopes define which APIs and resources a user can access using user-level API credentials and what actions they can perform using the API.

When the user creates their credentials, they must specify one or more available scopes. Available scopes depend on their user license, admin or supervisor. Admin users have all scopes available; supervisors have only Read or download interaction content and Read VCC user details, settings, and presences.

When the user then requests a bearer access token for their credentials using the VCC Authentication API, they must specify which of the credential's scopes the token is for. The scope for API credentials for most VCC APIs is in the format object:action. For example, agents-availability:read gives read access resources in the Agents Availability API, and interaction-content:read gives read access to interactions returned by the Conversation Analyzer API. See an individual API's documentation at Vonage Contact Center Developer Portal VCCA for the relevant scopes.