# entity.rights

URL: https://chugunov.pro/api-bitrix24/entity/entities/entity-rights/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить или изменить права доступа
Scope: `entity`
Кто может выполнять метод: получить текущие права может любой пользователь

## Описание

Метод `entity.rights` получает текущий набор прав доступа к хранилищу данных приложения или изменяет его.

Метод работает только в контексте [приложения](https://apidocs.bitrix24.ru/settings/app-installation/index.html).

## Параметры

- `ENTITY` `string` — необязательный. Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища. 
  Получить идентификатор можно методом [entity.get](https://chugunov.pro/api-bitrix24/entity/entities/entity-get/)
- `ACCESS` `object` — необязательный. Новый набор прав в формате `{"код_доступа":"уровень_права"}`.
  Примеры кодов доступа:
  - `U<id>` — пользователь, например `U1`
  - `G<id>` — группа пользователей, например `G2`
  - `AU` — все авторизованные пользователи
  Метод принимает стандартные коды доступа Битрикс24. Проверить название кода можно методом [access.name](https://chugunov.pro/api-bitrix24/common/system/access-name/).
  Поддерживаемые уровни:
  - `R` — чтение
  - `W` — запись
  - `X` — управление
  Если передан другой уровень, такая запись права не будет добавлена.
  При передаче `ACCESS` текущему пользователю принудительно добавляется право `X` (`U<id>`).
  Если параметр не передан, метод возвращает текущий набор прав доступа.

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "U1": "W",
        "AU": "R",
        "U577": "X"
    },
    "time": {
        "start": 1774267885,
        "finish": 1774267885.803565,
        "duration": 0.8035650253295898,
        "processing": 0,
        "date_start": "2026-03-23T15:11:25+03:00",
        "date_finish": "2026-03-23T15:11:25+03:00",
        "operating_reset_at": 1774268485,
        "operating": 0
    }
}
```

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

- `result` `result`. Корневой элемент ответа. Содержит актуальный набор прав доступа к хранилищу
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'ENTITY' is null or empty",
    "argument": "ENTITY"
}
```

- `ERROR_ARGUMENT` — Argument 'ENTITY' is null or empty. Параметр `ENTITY` не передан или пустой после очистки
- `ERROR_ARGUMENT` — Entity code is too long. Max length is 13 characters.. Слишком длинное значение `ENTITY`
- `ACCESS_DENIED` — Access denied!. Недостаточно прав для изменения прав доступа хранилища

## Примеры запроса

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish","ACCESS":{"U1":"W","AU":"R"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.rights
```

### JS (TS)

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

// Shape of the payload returned in result (match the "response handling" section of the page)
type EntityRightsResult = Record<string, string> | null

try {
  const response = await $b24.actions.v2.call.make<EntityRightsResult>({
    method: 'entity.rights',
    params: {
      ENTITY: 'dish',
      ACCESS: {
        U1: 'W',
        AU: 'R',
      },
    },
    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('Access rights:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 setEntityRights() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'entity.rights',
        params: {
          ENTITY: 'dish',
          ACCESS: {
            U1: 'W',
            AU: 'R',
          },
        },
        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('Access rights:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setEntityRights)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.entity.rights(
        entity="dish",
        access={
            "U1": "W",
            "AU": "R",
        },
    ).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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'entity.rights',
            [
                'ENTITY' => 'dish',
                'ACCESS' => [
                    'U1' => 'W',
                    'AU' => 'R',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo '<pre>';
    print_r($result);
    echo '</pre>';

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting entity rights: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'entity.rights',
    {
        ENTITY: 'dish',
        ACCESS: {
            U1: 'W',
            AU: 'R',
        },
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'entity.rights',
    [
        'ENTITY' => 'dish',
        'ACCESS' => [
            'U1' => 'W',
            'AU' => 'R',
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "entity.rights", b24.Params{
	"ENTITY": "dish",
	"ACCESS": b24.Params{
		"U1": "W",
		"AU": "R",
	},
})
if err != nil {
	return fmt.Errorf("entity.rights: %w", err)
}

var item struct {
	U1   string `json:"U1"`
	Au   string `json:"AU"`
	U577 string `json:"U577"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.U1, item.Au)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/entity/entities/entity-rights.html