Skip to main content
Back to Admin Console API Scopes define the level of access and control that an app has over various features and services within the platform. By creating apps and assigning appropriate scopes, developers and administrators can securely manage how different components of the platform are accessed and interacted with via public APIs. This modular approach ensures fine-grained access control, enabling you to expose only the required functionalities to each app or integration.

​
Getting Started

To begin using API scopes:
  1. Create an App
    • Click the + New API Scope button to create a new app.
    • Select the +Create App option from the App drop-down.
    • Enter an App Name. Once submitted, a Client ID and Client Secret are generated automatically.
    • These credentials are used to authenticate API requests made by the app.
  2. Assign API Scopes
    • Assign scopes based on the features your app needs to access.
    • Scopes are permission categories that unlock specific platform capabilities.
API Scopes

​
Supported API Scopes

The following API scopes are available for this feature.
API ScopeDescription
IntentIdentificationGrants access to detect intents and entities from an utterance using a secured API
BotDefinitionAllows app creation, export, and import operations
BatchTestEnables execution and management of Batch Test Suites, including running tests and retrieving results
BotPublishEnables publishing bots for deployment
TestAndTrainProvides access to train ML models, manage FAQs, and import/export utterances
LogsGrants access to retrieve app audit and admin console logs
GenAILLMUsageLogsAllows the retrieval of GenAI and LLM usage logs through secure APIs
ProfileManagementEnables role management and deletion of user data
BotAnalyticsAllows retrieval of chat history and conversation sessions
UserManagementSupports user management operations
CustomReportsAllows fetching of data used in custom widgets and reports
ManageKnowledgeGraphGrants permission to manage and export knowledge graph definitions
ChannelManagementEnables creation and update of communication channels
BotKitAllows configuration of botkits and agent transfers
MasterAdminGrants access to view and use sample bots
ProcessflowGrants permission to execute Process Apps using secure APIs
ProcessDefinitionEnables importing, exporting, and listing of Process Apps through secure APIs
ProcessPublishGrants permission to publish Process Apps securely via API
ProcessLogsGrants access to retrieve audit logs related to Process App executions and actions
LanguageSettingsAllows management of app languages—enabling/disabling languages, updating language settings, and changing the default language
Getlinkedbot detailsAssign this scope to get the linked app details for UB
AddlinkedbotAssign this scope to add a linked app to UB
ConversationTestsAssign this scope to manage and execute conversation test suites, including creation, deletion, and status retrieval
FileAccessAssign this scope to retrieve the download URL of an uploaded file
AnswersAssign these scopes to enable full control over Search AI, including Answer Generation, managing feedback, ingesting and maintaining data, configuring facets, chunks, highlights, and overseeing document and permission entities
Once an app is configured with the necessary scopes, it can be used either from within the App Builder Platform or externally through the platform’s public APIs. For the complete list of supported APIs, refer to the corresponding public API (see here for list).