Установить права доступа для сайта landing.site.setRights

Scope: landing

Кто может выполнять метод: администратор или пользователь с правом «полный доступ» к разделу «Сайты и магазины»

Метод landing.site.setRights устанавливает права доступа в расширенной модели прав для указанного сайта.

Метод работает только в расширенной модели прав. Если в разделе «Сайты и магазины» включена ролевая модель, вызов вернет true, но сохраненные права не будут применяться. Чтобы включить расширенную модель прав, используйте метод landing.role.enable со значением mode: 0.

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

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

Название
тип

Описание

id*
integer | string

Идентификатор сайта.

Идентификатор сайта можно получить с помощью метода landing.site.getList или из результата метода landing.site.add

Специальное значение 0 позволяет сохранить отдельный набор прав. Индивидуальные права конкретного сайта задаются по его id

rights
object | array

Объект формата:

{
            "access_code_1": ["operation_1", "operation_2"],
            "access_code_2": ["operation_1"]
        }

где:

access_code_n — код доступа
operation_n — код операции

Список кодов доступа и операций описан ниже. Метод полностью заменяет ранее сохраненные индивидуальные права для сайта.

Если параметр не передать, передать пустой объект {} или пустой массив [], метод очистит индивидуальные права сайта

Параметр rights

Название
тип

Описание

<ACCESS_CODE>
string[]

Список операций для одного кода доступа.

Возможные значения:
denied - запретить доступ
read - разрешить просмотр сайта
edit - разрешить изменять страницы сайта
sett - разрешить изменять настройки сайта
public - разрешить публикацию сайта
delete - разрешить перемещать сайт в корзину и восстанавливать его

Если в наборе есть denied, все остальные операции для этого кода доступа игнорируются.

Если в наборе нет read и нет denied, метод автоматически добавит read. Неизвестные коды операций игнорируются без ошибки

В качестве ключей объекта rights используйте коды доступа Битрикс24. Частые варианты:

U<ID> - пользователь
G<ID> - группа пользователей
DR<ID> - отдел вместе с подотделами
UA - все пользователи, включая гостей
AU - все авторизованные пользователи
SG<ID> - рабочая группа

Если доступ нужен только для авторизованных пользователей, используйте AU. Код UA открывает доступ всем пользователям, включая гостей. Метод не проверяет формат кода доступа при сохранении. Если передать неподдерживаемый код, запрос завершится без ошибки, но такой код не даст рабочего доступа.

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 645,
            "rights": {
              "AU": ["read"],
              "U3": ["read", "edit", "sett", "public"]
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.setRights.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 645,
            "rights": {
              "AU": ["read"],
              "U3": ["read", "edit", "sett", "public"]
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.setRights.json"

try
        {
            const response = await $b24.callMethod(
                'landing.site.setRights',
                {
                    id: 645,
                    rights: {
                        AU: ['read'],
                        U3: ['read', 'edit', 'sett', 'public']
                    }
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.setRights',
                    [
                        'id' => 645,
                        'rights' => [
                            'AU' => ['read'],
                            'U3' => ['read', 'edit', 'sett', 'public'],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting site rights: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.site.setRights',
            {
                id: 645,
                rights: {
                    AU: ['read'],
                    U3: ['read', 'edit', 'sett', 'public']
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.setRights',
            [
                'id' => 645,
                'rights' => [
                    'AU' => ['read'],
                    'U3' => ['read', 'edit', 'sett', 'public'],
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1775055086,
                "finish": 1775055086.8533,
                "duration": 0.8533000946044922,
                "processing": 0,
                "date_start": "2026-04-01T17:51:26+03:00",
                "date_finish": "2026-04-01T17:51:26+03:00",
                "operating_reset_at": 1775055686,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Результат сохранения прав.

true — права успешно сохранены или очищены
false — сайт с таким id не найден или уже находится в корзине

Метод не возвращает итоговый список прав

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Недостаточно параметров вызова, пропущены: id"
        }

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

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

Код	Описание
`ACCESS_DENIED`	У пользователя нет доступа к разделу «Сайты и магазины»
`IS_NOT_ADMIN`	Для изменения прав нужен полный доступ к разделу «Сайты и магазины»
`FEATURE_NOT_AVAIL`	Настройка прав недоступна на текущем тарифе. Чтобы работать с правами, перейдите на другой тариф
`MISSING_PARAMS`	Не передан обязательный параметр `id`

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

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	Превышен лимит на интенсивность запросов
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить права доступа

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

Установить права доступа для сайта landing.site.setRights

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

Параметр rightsПараметр rights

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

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

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

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

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

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

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

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

Параметр rights

Примеры кода

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

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

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

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

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

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