landing.role.getRights
Получить права роли
Описание
Метод landing.role.getRights возвращает права указанной роли по каждому сайту, для которого они настроены.
Параметры
scope
string
необязательный
Раздел, к которому относится роль. Параметр не связан с REST-скоупом landing в названии метода.
Значения GROUP, KNOWLEDGE и MAINPAGE соответствуют типам сайтов из статьи Работа с типами сайтов и скоупами.
Возможные значения:
GROUP — роли для сайтов групп
KNOWLEDGE — роли для баз знаний
MAINPAGE — роли для главной страницы или вайба
Если параметр не передать, метод работает с ролями для сайтов и интернет-магазинов. Для роли другого раздела или несуществующей роли метод вернет ошибку ROLE_SCOPE_MISMATCH
id
integer
обязательный
Идентификатор роли. Получить идентификатор можно с помощью метода landing.role.getList
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.getRights.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2,
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.role.getRights.json"
// 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 GetRightsResult = Record<string, string[]>
try {
const response = await $b24.actions.v2.call.make<GetRightsResult>({
method: 'landing.role.getRights',
params: {
id: 2,
},
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 rights by site:', Object.keys(result).map(siteId => `site ${siteId}: ${result[siteId].join(', ')}`))
}
} 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 getRoleRights() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.role.getRights',
params: {
id: 2,
},
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 rights by site:', Object.keys(result).map(siteId => `site ${siteId}: ${result[siteId].join(', ')}`))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRoleRights)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.role.get_rights(
bitrix_id=2,
).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(
'landing.role.getRights',
[
'id' => 2,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting role rights: ' . $e->getMessage();
}
BX24.callMethod(
'landing.role.getRights',
{
id: 2
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.role.getRights',
[
'id' => 2,
]
);
if (isset($result['error']))
{
echo 'Ошибка: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.role.getRights", b24.Params{
"id": 2,
})
if err != nil {
return fmt.Errorf("landing.role.getRights: %w", err)
}
// Форма ответа показана ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": {
"0": [
"read",
"edit"
],
"5": [
"read"
]
},
"time": {
"start": 1775064046,
"finish": 1775064046.935469,
"duration": 0.9354689121246338,
"processing": 0,
"date_start": "2026-04-01T20:20:46+03:00",
"date_finish": "2026-04-01T20:20:46+03:00",
"operating_reset_at": 1775064646,
"operating": 0
}
}
Возвращаемые данные
result
array
Массив прав роли по сайтам, где ключом выступает идентификатор сайта, а значением — массив кодов прав (подробное описание).
Если у роли нет сохраненных прав, метод возвращает пустой массив []
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "MISSING_PARAMS",
"error_description": "Недостаточно параметров вызова, пропущены: id"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Нет доступа к разделу «Сайты и магазины» | |
IS_NOT_ADMIN |
Для метода нужны права администратора или право «полный доступ» к разделу «Сайты и магазины» | |
FEATURE_NOT_AVAIL |
Управление правами в разделе «Сайты и магазины» недоступно на текущем тарифе | |
MISSING_PARAMS |
Не передан обязательный параметр id |
|
ROLE_SCOPE_MISMATCH |
Роль не относится к разделу из параметра scope. Метод возвращает эту ошибку и для роли другого раздела, и для несуществующей роли |

