Skip to content

permissions.md

Latest commit

 

History

History
104 lines (81 loc) · 7.2 KB

permissions.md

File metadata and controls

104 lines (81 loc) · 7.2 KB
Raw

Available Scopes in Bitrix24

{% note tip "" %}

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

A scope is a code for a group of methods. It defines which Bitrix24 tools an application or a webhook can access through the REST API. To find out how to select scopes for an application scenario and how a scope differs from user permissions, see Access Permissions for Methods and Scopes.

Quick navigation: Scope Codes

Where to Specify a Scope

For an application, scopes are selected when it is added, and the place depends on the solution type.

  • A mass-market solution is added in the Developer's Area. Scopes are specified in the technical specifications as the system sections the application interacts with. The procedure is described in the article How to Add a Solution in the Developer's Area.
  • A local application is added in Bitrix24, in Applications > Developer resources. The procedure is described in the article Local Applications.

For a webhook, scopes are selected when it is created, in the Assign permissions section. Requests run within the selected scopes and with the permissions of the employee who created the webhook. For details, see Inbound and Outbound Webhooks.

What Happens if a Method Is Called Outside the Granted Scope

If an application or a webhook calls a method whose scope has not been granted, Bitrix24 returns the insufficient_scope error and does not execute the request. Response to a call from an application:

{
    "error": "insufficient_scope",
    "error_description": "The request requires higher privileges than provided by the access token"
}

For a webhook, only error_description differs — it contains provided by the webhook token.

To make the call succeed, add the required scope to the application or webhook settings. Other system errors are collected in the article Error Codes.

When a Scope Alone Is Not Enough

Some methods work only in the application context. When a webhook calls such a method, Bitrix24 returns the WRONG_AUTH_TYPE error with the Application context required description. The placement.bind method behaves this way, for example.

Scope Codes {#codes}

#| || Scope Code | Scope Name| Bitrix24 Tool|| || ai_admin | Channel for registering a user service to process requests| Copilot || || biconnector | BI Analytics Connector | BIconnector || || bizproc | Business Processes | Business processes, RPA, CRM robots || || booking | Online Booking | Online Booking || || calendar | Calendar | Calendar || || call | Telephony (making calls). The scope includes methods: voximplant.infocall.startwithsound, voximplant.infocall.startwithtext| Telephony || || cashbox | Cash Registers | Cash Registers || || catalog | Product Catalog | Product catalog, inventory management || || contact_center | Contact Center Widget | Contact Center || || crm | CRM | CRM || || documentgenerator | Document Generator, CRM Document Generator | Document Generator || || delivery | Delivery | Online store, CRM || || department | Company Structure | Company Structure || || disk | Drive | Bitrix24.Drive || || entity | Data store | Data store || || humanresources | Company Structure REST 3.0 | Company Structure || || humanresources.hcmlink | e-Signature Integration with HR Systems | e-Signature || || im | Chat and Notifications | Chat and Notifications || || imbot | Creating and managing Chatbots | Chat bots || || imconnector | Connectors for external messengers | Open Channels || || imopenlines | Open Channels | Open Channels || || intranet | Widgets | Widgets || || landing | Websites | Websites || || lists | Lists | Universal lists || || log | Live Feed | News feed || || mailservice | Email Services | Email services || || main | Event Log | Event Log || || messageservice | Messaging Service | Messaging Service || || mobile | Mobile App | Mobile App || || pay_system | Payment Systems | Payment Systems || || placement | Widgets | App Embedding || || pull | Push&Pull | Push&Pull || || rpa | Business Automation | Business Automation || || sale | Online store | Online store || || salescenter | CRM. Payment | Chat sales || || sign.b2e | e-Signature | e-Signature || || sonet_group | Social Network Working Groups | Social Network Working Groups || || task | Tasks | Tasks || || telephony | Telephony | Telephony || || timeman | Time Tracking | Time Tracking || || user | Users Versions:

Service Scopes

rest.developer — a service scope of Alaio Vibecode. It is granted to the system webhooks that Vibecode creates to synchronize apps and AI agents with the Bitrix24 catalog.

[*key_task]: Additionally, three deprecated scopes are available — tasks, tasks_extended, tasksmobile. They should not be used.

[*key_sonet]: The socialnetwork scope does not grant access to any method. To work with working groups, specify sonet_group.