Получить или изменить права доступа entity.rights

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: entity

Кто может выполнять метод:

получить текущие права может любой пользователь

изменить права может пользователь с уровнем права X (управление) на хранилище данных

Метод entity.rights получает текущий набор прав доступа к хранилищу данных приложения или изменяет его.

Метод работает только в контексте приложения.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

ENTITY^*
string

Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища.

Получить идентификатор можно методом entity.get

ACCESS
object

Новый набор прав в формате {"код_доступа":"уровень_права"}.

Примеры кодов доступа:

U<id> — пользователь, например U1
G<id> — группа пользователей, например G2
AU — все авторизованные пользователи

Метод принимает стандартные коды доступа Битрикс24. Проверить название кода можно методом access.name.

Поддерживаемые уровни:

R — чтение
W — запись
X — управление

Если передан другой уровень, такая запись права не будет добавлена.

При передаче ACCESS текущему пользователю принудительно добавляется право X (U<id>).

Если параметр не передан, метод возвращает текущий набор прав доступа.

Примеры кода

Как использовать примеры в документации

Пример изменения прав доступа, где:

ENTITY — идентификатор хранилища dish
ACCESS — новый набор прав: U1 с уровнем W и AU с уровнем R

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish","ACCESS":{"U1":"W","AU":"R"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.rights

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type EntityRightsResult = Record<string, string> | null

try {
  const response = await $b24.actions.v2.call.make<EntityRightsResult>({
    method: 'entity.rights',
    params: {
      ENTITY: 'dish',
      ACCESS: {
        U1: 'W',
        AU: 'R',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Access rights:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function setEntityRights() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'entity.rights',
        params: {
          ENTITY: 'dish',
          ACCESS: {
            U1: 'W',
            AU: 'R',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Access rights:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setEntityRights)
</script>

try {
    $response = $b24Service
        ->core
        ->call(
            'entity.rights',
            [
                'ENTITY' => 'dish',
                'ACCESS' => [
                    'U1' => 'W',
                    'AU' => 'R',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo '<pre>';
    print_r($result);
    echo '</pre>';

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting entity rights: ' . $e->getMessage();
}

BX24.callMethod(
    'entity.rights',
    {
        ENTITY: 'dish',
        ACCESS: {
            U1: 'W',
            AU: 'R',
        },
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);

require_once('crest.php');

$result = CRest::call(
    'entity.rights',
    [
        'ENTITY' => 'dish',
        'ACCESS' => [
            'U1' => 'W',
            'AU' => 'R',
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "entity.rights", b24.Params{
	"ENTITY": "dish",
	"ACCESS": b24.Params{
		"U1": "W",
		"AU": "R",
	},
})
if err != nil {
	return fmt.Errorf("entity.rights: %w", err)
}

var item struct {
	U1   string `json:"U1"`
	Au   string `json:"AU"`
	U577 string `json:"U577"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.U1, item.Au)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "U1": "W",
        "AU": "R",
        "U577": "X"
    },
    "time": {
        "start": 1774267885,
        "finish": 1774267885.803565,
        "duration": 0.8035650253295898,
        "processing": 0,
        "date_start": "2026-03-23T15:11:25+03:00",
        "date_finish": "2026-03-23T15:11:25+03:00",
        "operating_reset_at": 1774268485,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `result`	Корневой элемент ответа. Содержит актуальный набор прав доступа к хранилищу
time `time`	Информация о времени выполнения запроса

Тип result

Название `тип`	Описание
`object`	Объект прав доступа в формате `{"код_доступа":"уровень_права"}`, где уровень права — `R`, `W` или `X`
`null`	Возвращается, если хранилище с переданным `ENTITY` не найдено

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'ENTITY' is null or empty",
    "argument": "ENTITY"
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_ARGUMENT`	Argument 'ENTITY' is null or empty	Параметр `ENTITY` не передан или пустой после очистки
`ERROR_ARGUMENT`	Entity code is too long. Max length is 13 characters.	Слишком длинное значение `ENTITY`
`ACCESS_DENIED`	Access denied!	Недостаточно прав для изменения прав доступа хранилища

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Удалить хранилище

Обзор методов

Получить или изменить права доступа entity.rights

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Тип resultТип result

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение