Получить список ролей landing.role.getList

Scope: landing

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

Метод landing.role.getList получает список ролей доступа для выбранного типа сайтов.

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

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

Название
тип

Описание

scope
string

Тип сайтов, для которого нужно получить роли. Параметр не связан с REST-скоупом landing в названии метода.

Значения GROUP, KNOWLEDGE и MAINPAGE соответствуют типам сайтов из статьи Работа с типами сайтов и скоупами.

Возможные значения:
GROUP - роли для сайтов групп
KNOWLEDGE - роли для баз знаний
MAINPAGE - роли для главной страницы или вайба

Если параметр не передали или указали неверно, метод вернет роли для сайтов и интернет-магазинов. Например, так будет, если значение пустое, не строковое или не поддерживается

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "scope": "KNOWLEDGE"
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.getList.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "scope": "KNOWLEDGE",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.role.getList.json"

try
        {
            const response = await $b24.callMethod(
                'landing.role.getList',
                {
                    scope: 'KNOWLEDGE'
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.role.getList',
                    [
                        'scope' => 'KNOWLEDGE',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting role list: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.role.getList',
            {
                scope: 'KNOWLEDGE'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.role.getList',
            [
                'scope' => 'KNOWLEDGE',
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "3",
                    "TITLE": "Администратор",
                    "XML_ID": "ADMIN"
                },
                {
                    "ID": "5",
                    "TITLE": "Менеджер",
                    "XML_ID": "MANAGER"
                }
            ],
            "time": {
                "start": 1775062049,
                "finish": 1775062049.634052,
                "duration": 0.634052038192749,
                "processing": 0,
                "date_start": "2026-04-01T19:47:29+03:00",
                "date_finish": "2026-04-01T19:47:29+03:00",
                "operating_reset_at": 1775062649,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object[]

Список ролей выбранного типа сайтов (подробное описание).

Если роли не найдены, метод возвращает result: []

time
time

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

Объект role

Название `тип`	Описание
ID `string`	Идентификатор роли. Используйте его в методах landing.role.getRights, landing.role.setAccessCodes и landing.role.setRights
TITLE `string`	Название роли в интерфейсе
XML_ID `string`	Системный код роли. Возможные значения для автоматически созданных стандартных ролей: `ADMIN` - администратор `MANAGER` - менеджер

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

HTTP-статус: 400

{
            "error": "IS_NOT_ADMIN",
            "error_description": "Для совершения действия необходимо быть администратором."
        }

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

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

Код	Описание
`ACCESS_DENIED`	Нет авторизации или недостаточно прав для работы с модулем «Сайты и магазины»
`IS_NOT_ADMIN`	Метод доступен пользователю с правами администратора
`FEATURE_NOT_AVAIL`	На текущем тарифе недоступно управление правами в разделе «Сайты и магазины»

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

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.getList

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

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

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

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

Объект roleОбъект role

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

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

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

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