Привязать пользователей к ролям documentgenerator.role.fillaccesses

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

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

Scope: documentgenerator

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

Метод documentgenerator.role.fillaccesses полностью перезаписывает карту привязок ролей к кодам доступа.

Метод перезаписывает настройки полностью.

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

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

Название
тип

Описание

accesses
array

Массив привязок роли к коду доступа (подробное описание)

Элемент массива accesses

Название
тип

Описание

roleId*
integer

Идентификатор роли.

Получить идентификатор можно после создания роли или методом получения списка ролей

accessCode*
string

Код доступа пользователя, группы или отдела.

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

  • U{id} — пользователь
  • G{id} — группа пользователей
  • AU — все авторизованные пользователи
  • UA — все пользователи
  • D{id} — отдел
  • DR{id} — отдел с подотделами
  • SG{id} — рабочая группа или проект
  • SG{id}_A — владелец рабочей группы или проекта
  • SG{id}_E — модераторы рабочей группы или проекта
  • SG{id}_K — все члены рабочей группы или проекта

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "accesses": [
      {
        "roleId": 9,
        "accessCode": "U1"
      },
      {
        "roleId": 9,
        "accessCode": "D1"
      },
      {
        "roleId": 9,
        "accessCode": "UA"
      }
    ]
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.fillaccesses
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "accesses": [
      {
        "roleId": 9,
        "accessCode": "U1"
      },
      {
        "roleId": 9,
        "accessCode": "D1"
      },
      {
        "roleId": 9,
        "accessCode": "UA"
      }
    ],
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/documentgenerator.role.fillaccesses
// 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<null>({
    method: 'documentgenerator.role.fillaccesses',
    params: {
      accesses: [
        {
          roleId: 9,
          accessCode: 'U1',
        },
        {
          roleId: 9,
          accessCode: 'D1',
        },
        {
          roleId: 9,
          accessCode: 'UA',
        },
      ],
    },
    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('Role accesses applied successfully, result:', 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 fillRoleAccesses() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'documentgenerator.role.fillaccesses',
        params: {
          accesses: [
            {
              roleId: 9,
              accessCode: 'U1',
            },
            {
              roleId: 9,
              accessCode: 'D1',
            },
            {
              roleId: 9,
              accessCode: 'UA',
            },
          ],
        },
        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('Role accesses applied successfully, result:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.documentgenerator.role.fillaccesses(
        accesses=[
            {
                "roleId": 9,
                "accessCode": "U1",
            },
            {
                "roleId": 9,
                "accessCode": "D1",
            },
            {
                "roleId": 9,
                "accessCode": "UA",
            },
        ],
    ).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(
        'documentgenerator.role.fillaccesses',
        [
            'accesses' => [
                [
                    'roleId' => 9,
                    'accessCode' => 'U1',
                ],
                [
                    'roleId' => 9,
                    'accessCode' => 'D1',
                ],
                [
                    'roleId' => 9,
                    'accessCode' => 'UA',
                ],
            ],
        ]
    );

    $result = $response->getResponseData()->getResult();
    var_dump($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'documentgenerator.role.fillaccesses',
    {
        accesses: [
            {
                roleId: 9,
                accessCode: 'U1'
            },
            {
                roleId: 9,
                accessCode: 'D1'
            },
            {
                roleId: 9,
                accessCode: 'UA'
            }
        ]
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'documentgenerator.role.fillaccesses',
    [
        'accesses' => [
            [
                'roleId' => 9,
                'accessCode' => 'U1',
            ],
            [
                'roleId' => 9,
                'accessCode' => 'D1',
            ],
            [
                'roleId' => 9,
                'accessCode' => 'UA',
            ],
        ],
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.role.fillaccesses", b24.Params{
	"accesses": []b24.Params{
		{
			"roleId":     9,
			"accessCode": "U1",
		},
		{
			"roleId":     9,
			"accessCode": "D1",
		},
		{
			"roleId":     9,
			"accessCode": "UA",
		},
	},
})
if err != nil {
	return fmt.Errorf("documentgenerator.role.fillaccesses: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "result": null,
    "time": {
        "start": 1773914210,
        "finish": 1773914211.747039,
        "duration": 1.7470390796661377,
        "processing": 1,
        "date_start": "2026-03-19T12:56:50+03:00",
        "date_finish": "2026-03-19T12:56:51+03:00",
        "operating_reset_at": 1773914810,
        "operating": 1.222714900970459
    }
}

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

Название
тип

Описание

result
null

Метод применяет новые привязки и возвращает null.

Также возвращает null без ошибок:

  • если не передан обязательный параметр accesses
  • передан несуществующий roleId
  • передан несуществующий accessCode

time
time

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

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

HTTP-статус: 400, 403

{
    "error": "0",
    "error_description": "You do not have permissions to modify settings"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

BX_EMPTY_REQUIRED

Не заполнено обязательное поле "ROLE_ID"

В одном из элементов accesses не передан roleId

400

BX_EMPTY_REQUIRED

Не заполнено обязательное поле "ACCESS_CODE"

В одном из элементов accesses не передан accessCode

400

0

You do not have permissions to modify settings

Недостаточно прав на изменение настроек генератора документов

403

DOCGEN_ACCESS_ERROR

Your plan does not support this operation

На тарифе недоступна функция разграничения прав для генератора документов

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

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

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

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

Предыдущая
Следующая