disk-folder-share-to-user.md

Assign Access Permissions to Folder disk.folder.shareToUser

{% note tip "" %}

Choose a tool for developing with an AI agent:

• use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
• use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

Scope: disk

Who can execute the method: a user with "Share" permission for the specified folder

The method disk.folder.shareToUser assigns access permissions to a folder.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* integer | Identifier of the folder.

The identifier can be obtained using the method disk.storage.getChildren if the folder is located at the root of the storage, and using the method disk.folder.getChildren if the folder is located in another folder || || userId* integer | Identifier of the user to whom access is granted.

The identifier can be obtained using the method user.get || || taskName* string | Level of access granted to the user. Possible values:

• disk_access_read — read
• disk_access_add — add
• disk_access_edit — edit
• disk_access_full — full access || |#

{% note info "" %}

The current user cannot grant permissions higher than their own level. For example, if the current user only has "Read" permission for the specified folder, they will not be able to grant another user "Edit" or "Full access" permissions.

{% endnote %}

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  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 (OAuth)

  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

• JS (TS)

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

• JS (UMD)

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

• Python

  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 error",
          f"error: {error.error}",
          f"error_description: {error.error_description}",
          sep="\n",
      )
  except BitrixSDKException as error:
      print(f"Bitrix SDK error: {error.message}")
  except Exception as error:
      print(f"Unexpected error: {error}")

• PHP

  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.js

  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());
      }
  );

• PHP CRest

  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>';

• Go

  // client and ctx are already created — see the Go SDK section
  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("parse response: %w", err)
  }
  fmt.Println("done:", ok)

{% endlist %}

Response Handling

HTTP status: 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
    }
}

Returned Data

#| || Name type | Description || || result boolean | Returns true if permissions are successfully assigned || || time time | Information about the request execution time || |#

Error Handling

HTTP status: 400 or 403

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

{% include notitle Error handling %}

Possible Error Codes

#| || Status | Code | Description | Value || || 400 | ERROR_ARGUMENT | Invalid value of parameter {Parameter #1} | Required parameter not specified || || 400 | ERROR_NOT_FOUND | Could not find entity with id X | The folder with the specified id was not found || || 403 | ACCESS_DENIED | Access denied! | Folder sharing is disabled in Bitrix24 || || 403 | ACCESS_DENIED | Access denied! | Attempt to set a permission level higher than the current user's level || || 403 | ACCESS_DENIED | Access denied! | Incorrect value provided for the taskName parameter || |#

{% include System errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}