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

Scope: landing

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

Метод landing.role.setRights устанавливает права роли по сайтам. Для каждого сайта можно задать отдельные права, а для остальных — общие права по умолчанию. Новый набор прав полностью заменяет предыдущий.

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

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

Название
тип

Описание

id*
integer

Идентификатор роли, для которой нужно обновить права.

Получить идентификатор можно с помощью метода landing.role.getList

Если передать идентификатор несуществующей роли, метод не вернет отдельную ошибку

rights*
object | array

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

{
            "0": ["read"],
            "<siteId>": ["read", "edit", "sett"]
        }

где:

  • 0 — право по умолчанию для сайтов без отдельной настройки
  • <siteId> — идентификатор сайта

Список доступных кодов прав описан ниже, а структура объекта — в таблице параметра rights.

Метод полностью заменяет ранее сохраненные права роли по сайтам

additional
string[]

Дополнительные возможности роли.

Возможные значения:

  • menu24 — показывать для роли пункт меню «Сайты и магазины»
  • create — разрешить создавать новые сайты

Если параметр не передавать, текущие дополнительные возможности роли сохранятся

Параметр rights

Название
тип

Описание

0
string[]

Права роли по умолчанию для всех сайтов, у которых нет отдельной настройки.

Доступные коды прав описаны ниже

<siteId>
string[]

Права роли для сайта с указанным идентификатором.

Ключом служит идентификатор сайта, значением — массив кодов прав. Если сайт с таким идентификатором не найден, запись будет пропущена без ошибки.

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

Для каждого сайта передавайте массив кодов прав. Если вместо массива передать другое значение, запись для этого сайта будет пропущена без ошибки

Коды прав

Код

Описание

denied

Доступ к сайту запрещен

read

Просмотр сайта

edit

Изменение страниц сайта

sett

Изменение настроек сайта

public

Публикация

delete

Удаление в корзину и восстановление из корзины

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 11,
            "rights": {
              "0": ["read"],
              "66": ["read", "edit", "sett"],
              "71": ["denied"]
            },
            "additional": ["menu24", "create"]
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.setRights.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 11,
            "rights": {
              "0": ["read"],
              "66": ["read", "edit", "sett"],
              "71": ["denied"]
            },
            "additional": ["menu24", "create"],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.role.setRights.json"
        
try
        {
            const response = await $b24.callMethod(
                'landing.role.setRights',
                {
                    id: 11,
                    rights: {
                        0: ['read'],
                        66: ['read', 'edit', 'sett'],
                        71: ['denied']
                    },
                    additional: ['menu24', 'create']
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.role.setRights',
                    [
                        'id' => 11,
                        'rights' => [
                            0 => ['read'],
                            66 => ['read', 'edit', 'sett'],
                            71 => ['denied'],
                        ],
                        'additional' => ['menu24', 'create'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting role rights: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.role.setRights',
            {
                id: 11,
                rights: {
                    0: ['read'],
                    66: ['read', 'edit', 'sett'],
                    71: ['denied']
                },
                additional: ['menu24', 'create']
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.role.setRights',
            [
                'id' => 11,
                'rights' => [
                    0 => ['read'],
                    66 => ['read', 'edit', 'sett'],
                    71 => ['denied'],
                ],
                'additional' => ['menu24', 'create'],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1775071662,
                "finish": 1775071663.148474,
                "duration": 1.1484739780426025,
                "processing": 0,
                "date_start": "2026-04-01T22:27:42+03:00",
                "date_finish": "2026-04-01T22:27:43+03:00",
                "operating_reset_at": 1775072263,
                "operating": 0.1147608757019043
            }
        }

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

Название
тип

Описание

result
boolean

Результат вызова.

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

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

ACCESS_DENIED

Недостаточно прав для работы с разделом «Сайты и магазины»

IS_NOT_ADMIN

Пользователь не является администратором

FEATURE_NOT_AVAIL

Управление правами в разделе «Сайты и магазины» недоступно на текущем тарифе

MISSING_PARAMS

Не передан обязательный параметр id или rights

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

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Установить коды доступа для роли
Следующая
Полезные ссылки