Назначить права доступа на папку disk.folder.sharetouser

Scope: disk

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

Метод disk.folder.sharetouser назначает права доступа на папку.

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

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

Название `тип`	Описание
id* `integer`	Идентификатор папки. Идентификатор можно получить с помощью метода disk.storage.getchildren, если папка находится в корне хранилища, и с помощью метода disk.folder.getchildren, если папка находится в другой папке
userId* `integer`	Идентификатор пользователя, которому выдается доступ. Идентификатор можно получить с помощью метода user.get
taskName* `string`	Уровень прав, который выдается пользователю. Возможные значения: `disk_access_read` — чтение `disk_access_add` — добавление `disk_access_edit` — редактирование `disk_access_full` — полный доступ

Текущий пользователь не может выдать права выше своего уровня. Например, если у текущего пользователля только право «Чтение» для нужной папки, он не сможет выдать другому пользователю права «Редактирование» или «Полный доступ»

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8994,"userId":1271,"taskName":"disk_access_read"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/disk.folder.sharetouser

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8994,"userId":1271,"taskName":"disk_access_read","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.folder.sharetouser

try
        {
            const response = await $b24.callMethod(
                'disk.folder.sharetouser',
                {
                    id: 8994,
                    userId: 1271,
                    taskName: 'disk_access_read',
                }
            );
            
            const result = response.getData().result;
            console.log('Folder shared to user with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.folder.sharetouser',
                    [
                        'id' => 8994,
                        'userId' => 1271,
                        'taskName' => 'disk_access_read'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error sharing folder to user: ' . $e->getMessage();
        }

BX24.callMethod(
            "disk.folder.sharetouser",
            {
                id: 8994,              
                userId: 1271,           
                taskName: 'disk_access_read'
            },
            function (result) 
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'disk.folder.sharetouser',
            [
                'id' => 8994,
                'userId' => 1271,
                'taskName' => 'disk_access_read'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1768921227,
                "finish": 1768921228.02202,
                "duration": 1.0220201015472412,
                "processing": 1,
                "date_start": "2026-01-20T17:00:27+03:00",
                "date_finish": "2026-01-20T17:00:28+03:00",
                "operating_reset_at": 1768921827,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `boolean`	Возвращает `true`, если права назначены успешно
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error":"ERROR_ARGUMENT",
            "error_description":"Invalid value of parameter {Parameter #1}"
        }

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

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

Код	Описание	Значение
`ERROR_ARGUMENT`	Invalid value of parameter	Не указан обязательный параметр
`ERROR_NOT_FOUND`	Could not find entity with id `X`	Папка с указанным `id` не найдена
`ACCESS_DENIED`	Access denied	Попытка задать уровень прав выше, чем у текущего пользователя
`ACCESS_DENIED`	Access denied	Неверно передано значение параметра `taskName`

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

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

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

Восстановить папку из корзины

Загрузить файл в указанную папку

Назначить права доступа на папку disk.folder.sharetouser

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

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

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

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

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

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

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

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