Access Permissions for REST Methods
Access for applications (and webhooks) to REST API methods is regulated via the access to the scopes - Bitrix24 modules that execute particular REST methods.
In case of local apps and webhooks, a user with the permissions to administrate Bitrix24 specifies the required scopes when adding an app or when creating a webhook.
If an off-the-shelf app is installed, this app will request access permissions from the user for the necessary scopes and the user will either grant the requested access permission rights, or will interrupt the app installation process.
At present, the following scopes can be used:
| Values | |
|---|---|
| ai_admin | Channel for registering custom service for query processing |
| biconnector | BI-analytics |
| bizproc | Workflows |
| calendar | Calendar |
| call | Telephony (making calls). The following methods are included into the scope:
voximplant.infocall.startwithsound voximplant.infocall.startwithtext |
| catalog | Catalog |
| contact_center | Contact center |
| crm | CRM |
| crm.documentgenerator | CRM document generator |
| delivery | Deliveries |
| department | Company Structure |
| disk | Drive |
| entity | Data Storage |
| forum | Forum |
| im | Notifications |
| imbot | Chatbots |
| imopenlines | Open Channels |
| intranet | Intranet |
| landing | Sites |
| lists | Lists |
| log | Feed |
| mailservice | Mailservice |
| messageservice | Message Service |
| mobile | Mobile Application |
| pay_system | Payment systems |
| placement | Application Embedding |
| pull | Pull&Push |
| rpa | Robotic process automation (RPA) |
| sale | Online Store |
| sonet_group | Workgroups |
|
task
Also there are three legacy scopes: tasks, tasks_extended, tasksmobile, - don't use them. | Tasks |
| telephony | Telephony |
| timeman | Time Management |
| user | Users. Versons:
|
| user.userfield | Custom user fields |
| userfieldconfig | Handling Parent Fields |
| userconsent | User agreement/consent |
| rating | Ratings |
| smile | Smileys |
| iblock | Information blocks |
| configuration.import | Solution preset import |
| salescenter | Chat enabled sales |
| cashbox | Cash registers |
| landing_cloud | Handling repository |
| pull_channel | Service channel for system instant messaging (subscription to information on updates for all system elements available to user) |
© «Bitrix24», 2001-2024