disk.folder.shareToUser
Назначить права доступа на папку
Описание
Метод 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 -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_webhook_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
// 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: 'disk.folder.shareToUser',
params: {
id: 8994,
userId: 1271,
taskName: 'disk_access_read',
},
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('Folder shared to user:', 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 shareFolderToUser() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'disk.folder.shareToUser',
params: {
id: 8994,
userId: 1271,
taskName: 'disk_access_read',
},
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('Folder shared to user:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', shareFolderToUser)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.disk.folder.sharetouser(
bitrix_id=8994,
user_id=1271,
task_name="disk_access_read",
).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(
'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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "disk.folder.shareToUser", b24.Params{
"id": 8994,
"userId": 1271,
"taskName": "disk_access_read",
})
if err != nil {
return fmt.Errorf("disk.folder.shareToUser: %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": 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_ARGUMENT |
Invalid value of parameter {Parameter #1} | Не указан обязательный параметр |
ERROR_NOT_FOUND |
Could not find entity with id X |
Папка с указанным id не найдена |
ACCESS_DENIED |
Access denied | Попытка задать уровень прав выше, чем у текущего пользователя |
ACCESS_DENIED |
Access denied | Неверно передано значение параметра taskName |

