API Scopes¶
Using this option you can define apps and associate API scopes for accessing various platform features.
- Use the New button to create a new app.
- Select +Create App option from App drop-down.
- Once you enter a name, a Client ID and Client Secret would be generated which can be used to access the platform
-
For each app created the following API Scopes can be assigned as per requirement:
- IntentIdentification includes the scopes for Intent and Entity Detection;
- Bot Definition includes the scopes for Bot Import, Export and Creation;
- Bot Publish for Publish access;
- Test & Train to include permissions to Train ML and FAQ, Utterances Import & Export;
- Logs to include retrieval capablity of Bot Audit and Admin Console Audit Logs;
- Profile Management to get access to Role Management APIs and to Delete User Data;
- Bot Analytics to be able to retrieve Chat History and Bot conversation Sessions
- User Management scope to manage users;
- Custom Reports scope to retrieve the data associated with custom widgets and reports;
- ManageKnowledgeGraph scope to export and manage the complete definition of the Knowledge Graph;
- Channel Management to create and update channels;
- BotKit to configure the botkit and agent transfer;
- Master Admin – assign this scope to get the list of sample bot.
-
Once created these apps can be used from within the Bot Builder Platform or externally to access various features by invoking the corresponding public API (see here for list).