Установить коды доступа для роли landing.role.setAccessCodes

Scope: landing

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

Метод landing.role.setAccessCodes задает, кому назначена роль: пользователям, группам или отделам. После вызова метод заново применяет уже сохраненные права этой роли для сайтов.

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

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

Название
тип

Описание

id*
integer

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

codes
string[]

Итоговый список кодов доступа для роли.

Метод полностью заменяет ранее сохраненный список и не объединяет его с текущим.

Варианты кодов доступа:

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

Подробнее о кодах доступа и правилах их использования рассказано в описании метода landing.site.setRights

Метод не проверяет каждый код доступа по отдельности. Если в списке есть неподдерживаемый или несуществующий код, отдельной ошибки не будет

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

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

Получить сохраненный список кодов доступа через REST нельзя. Метод landing.role.getList возвращает только идентификатор, название и XML_ID роли, а landing.role.getRights показывает только права роли по сайтам

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 11,
            "codes": [
              "U45",
              "DR7",
              "SG3_A"
            ]
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.setAccessCodes.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 11,
            "codes": [
              "U45",
              "DR7",
              "SG3_A"
            ],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.role.setAccessCodes.json"

try
        {
            const response = await $b24.callMethod(
                'landing.role.setAccessCodes',
                {
                    id: 11,
                    codes: [
                        'U45',
                        'DR7',
                        'SG3_A'
                    ]
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.role.setAccessCodes',
                    [
                        'id' => 11,
                        'codes' => [
                            'U45',
                            'DR7',
                            'SG3_A',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting role access codes: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.role.setAccessCodes',
            {
                id: 11,
                codes: [
                    'U45',
                    'DR7',
                    'SG3_A'
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.role.setAccessCodes',
            [
                'id' => 11,
                'codes' => [
                    'U45',
                    'DR7',
                    'SG3_A',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1775067129,
                "finish": 1775067129.196438,
                "duration": 0.19643807411193848,
                "processing": 0,
                "date_start": "2026-04-01T21:12:09+03:00",
                "date_finish": "2026-04-01T21:12:09+03:00",
                "operating_reset_at": 1775067729,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

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

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

Значение true само по себе не подтверждает, что роль с таким 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`
`ERROR_ARGUMENT`	Параметр `codes` передан не в формате массива

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

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.role.setAccessCodes

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

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

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

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

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

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

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

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