Get Role Rights with landing.role.getRights
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
Scope:
landingWho can execute the method: administrator or user with "full access" permission to the "Sites and Stores" section.
The method landing.role.getRights returns the rights of the specified role for each site where they are configured.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
The section the role belongs to. This parameter is not related to the REST scope The values Possible values: If the parameter is not provided, the method works with roles for sites and online stores. For a role from another section or a non-existent role, the method returns the error |
|
id* |
Role identifier. You can obtain the identifier using the landing.role.getList method |
Code Examples
How to Use Examples in Documentation
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 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}")
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 'Error: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.role.getRights", b24.Params{
"id": 2,
})
if err != nil {
return fmt.Errorf("landing.role.getRights: %w", err)
}
// The response shape is shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP Status: 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+02:00",
"date_finish": "2026-04-01T20:20:46+02:00",
"operating_reset_at": 1775064646,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of role rights by sites, where the key is the site identifier and the value is an array of rights codes (detailed description). If the role has no saved rights, the method returns an empty array |
|
time |
Information about the execution time of the request |
Result Element
|
Name |
Description |
|
|
Default role rights for all sites that do not have separate settings. Available values are described below |
|
|
Role rights for the site with the specified identifier. The site identifier can be obtained using the landing.site.getList method or from the result of the landing.site.add method. Available values are described below |
Rights Codes
|
Code |
Description |
|
|
Access to the site is denied |
|
|
Read |
|
|
Modify site pages |
|
|
Change site settings |
|
|
Publish |
|
|
Move to trash and restore from trash |
Error Handling
HTTP Status: 400
{
"error": "MISSING_PARAMS",
"error_description": "Not enough call parameters, missing: id"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
No access to the "Sites and Stores" section |
|
|
Administrator rights or "full access" permission to the "Sites and Stores" section are required for the method |
|
|
Rights management in the "Sites and Stores" section is not available on the current plan |
|
|
Required parameter |
|
|
The role does not belong to the section specified in the |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |