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

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

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

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 -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"
// 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.site.setRights',
    params: {
      id: 645,
      rights: {
        AU: ['read'],
        U3: ['read', 'edit', 'sett', 'public'],
      },
    },
    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('Rights saved:', 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 setSiteRights() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'landing.site.setRights',
        params: {
          id: 645,
          rights: {
            AU: ['read'],
            U3: ['read', 'edit', 'sett', 'public'],
          },
        },
        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('Rights saved:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setSiteRights)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.site.set_rights(
        bitrix_id=645,
        rights={
            "AU": [
                "read",
            ],
            "U3": [
                "read",
                "edit",
                "sett",
                "public",
            ],
        },
    ).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.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>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.site.setRights", b24.Params{
	"id": 645,
	"rights": b24.Params{
		"AU": []string{"read"},
		"U3": []string{"read", "edit", "sett", "public"},
	},
})
if err != nil {
	return fmt.Errorf("landing.site.setRights: %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": 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 не найден или уже находится в корзине

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

После вызова проверьте примененные права методом landing.site.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

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

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

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

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