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

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

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

Scope: landing

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

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

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

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

Название `тип`	Описание
scope `string`	Раздел, к которому относится роль. Параметр не связан с REST-скоупом `landing` в названии метода. Значения `GROUP`, `KNOWLEDGE` и `MAINPAGE` соответствуют типам сайтов из статьи Работа с типами сайтов и скоупами. Возможные значения: `GROUP` — роли для сайтов групп `KNOWLEDGE` — роли для баз знаний `MAINPAGE` — роли для главной страницы или вайба Если параметр не передать, метод работает с ролями для сайтов и интернет-магазинов. Для роли другого раздела метод вернет ошибку `ROLE_SCOPE_MISMATCH`
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)

JS (TS)

JS (UMD)

Python

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"

// 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

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'landing.role.setAccessCodes',
    params: {
      id: 11,
      codes: [
        'U45',
        'DR7',
        'SG3_A',
      ],
    },
    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 codes updated:', 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 setRoleAccessCodes() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'landing.role.setAccessCodes',
        params: {
          id: 11,
          codes: [
            'U45',
            'DR7',
            'SG3_A',
          ],
        },
        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 codes updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.role.set_access_codes(
        bitrix_id=11,
        codes=[
            "U45",
            "DR7",
            "SG3_A",
        ],
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.role.setAccessCodes", b24.Params{
	"id":    11,
	"codes": []string{"U45", "DR7", "SG3_A"},
})
if err != nil {
	return fmt.Errorf("landing.role.setAccessCodes: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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 существует или что список кодов был изменен.

После вызова проверьте результат в интерфейсе. Через REST можно дополнительно проверить, какие права роли применяются к сайтам, методом landing.role.getRights, но итоговый список кодов доступа этот метод не возвращает

time
time

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

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

HTTP-статус: 400

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

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

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

Код	Описание
`ACCESS_DENIED`	Недостаточно прав для работы с разделом «Сайты и магазины»
`IS_NOT_ADMIN`	Для метода нужны права администратора или право «полный доступ» к разделу «Сайты и магазины»
`FEATURE_NOT_AVAIL`	Управление правами в разделе «Сайты и магазины» недоступно на текущем тарифе
`MISSING_PARAMS`	Не передан обязательный параметр `id`
`ERROR_ARGUMENT`	Параметр `codes` передан не в формате массива
`ROLE_SCOPE_MISMATCH`	Роль не относится к разделу из параметра `scope`. Метод возвращает эту ошибку и для роли другого раздела, и для несуществующей роли

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

Получить список сайтов с правами для роли

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

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

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

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

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

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

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

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

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

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