Set Role Rights for Site Lists landing.role.setRights
We are still updating this page
Some data may be missing here — we will complete it shortly.
Scope: landing | Execution Rights: administrator
The method landing.role.setRights sets the necessary rights within a role for site lists. All other sites not specified in the incoming array are considered unlinked from the role.
The keys of the array are the site identifiers, and the values are arrays of available operations (a zero key means default access for the role):
- denied - all access denied,
- read – read (this right is automatically granted by the system when any other right except denied is specified),
- edit – modify (page content),
- sett – change settings,
- public – publish,
- delete – delete (to trash, and restore from trash).
Parameters
|
Parameters |
Description |
|
id |
Role identifier. |
|
rights |
Array of sites for rights binding. See example. |
|
additional |
Optionally, an array with additional rights can be passed, specifying who is allowed within the role:
|
Examples
try
{
const response = await $b24.callMethod(
'landing.role.setRights',
{
id: 11,
rights: {
'0': ['read'],
'66': ['read','edit','sett']
},
additional: ['menu24', 'create']
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.role.setRights',
[
'id' => 11,
'rights' => [
'0' => ['read'],
'66' => ['read', 'edit', 'sett']
],
'additional' => ['menu24', 'create']
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your required data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting role rights: ' . $e->getMessage();
}
BX24.callMethod(
'landing.role.setRights',
{
id: 11,
rights: {
'0': ['read'],
'66': ['read','edit','sett']
},
additional: ['menu24', 'create']
},
function(result)
{
if(result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
How to Use Examples in Documentation