Set Access Codes for Role landing.role.setAccessCodes

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: landing

Who can execute the method: administrator or user with "full access" permission to the "Sites and Stores" section.

The method landing.role.setAccessCodes specifies to whom the role is assigned: users, groups, or departments. After invocation, the method reapplies the already saved permissions of this role for the sites.

Method Parameters

Required parameters are marked with *

Name
type

Description

scope
string

The section the role belongs to. This parameter is not related to the REST scope landing in the method name.

The values GROUP, KNOWLEDGE, and MAINPAGE correspond to the types of sites described in the article Working with Site Types and Scopes.

Possible values:
GROUP - roles for group sites
KNOWLEDGE - roles for knowledge bases
MAINPAGE - roles for the main page or vibe

If the parameter is not provided, the method works with roles for sites and online stores. For a role from another section, the method returns the error ROLE_SCOPE_MISMATCH

id*
integer

Role identifier. You can obtain the identifier using the method landing.role.getList

codes
string[]

The final list of access codes for the role.

The method completely replaces the previously saved list and does not merge it with the current one.

Access code options:

  • U<ID> — user
  • G<ID> — user group
  • DR<ID> — department along with sub-departments
  • AU — all authorized users
  • SG<ID> — working group

More details about access codes and their usage rules can be found in the description of the method landing.site.setRights.

The method does not check each access code individually. If there is an unsupported or non-existent code in the list, there will be no separate error.

If the codes parameter is not provided, the role's code list will be cleared. However, the saved role permissions for the sites do not automatically disappear, so after invocation, access may remain for more users than expected.

After changing the access codes, the system recalculates not only the permissions for the sites but also the additional permissions of the role: the ability to create sites, view the "Sites and Stores" section in the menu, and administer the section.

You cannot retrieve the saved list of access codes via REST. The method landing.role.getList returns only the identifier, name, and XML_ID of the role, while landing.role.getRights shows only the role's permissions for the sites.

If the codes parameter is passed in a format other than an array, the method will return an ERROR_ARGUMENT error.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 11,
            "codes": [
              "U45",
              "DR7",
              "SG3_A"
            ]
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.setAccessCodes.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 11,
            "codes": [
              "U45",
              "DR7",
              "SG3_A"
            ],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.role.setAccessCodes.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
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'landing.role.setAccessCodes',
            params: {
              id: 11,
              codes: [
                'U45',
                'DR7',
                'SG3_A',
              ],
            },
            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 codes updated:', result)
          }
        } 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 setRoleAccessCodes() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.role.setAccessCodes',
                params: {
                  id: 11,
                  codes: [
                    'U45',
                    'DR7',
                    'SG3_A',
                  ],
                },
                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 codes updated:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', setRoleAccessCodes)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.role.set_access_codes(
                bitrix_id=11,
                codes=[
                    "U45",
                    "DR7",
                    "SG3_A",
                ],
            ).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.setAccessCodes',
                    [
                        'id' => 11,
                        'codes' => [
                            'U45',
                            'DR7',
                            'SG3_A',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting role access codes: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.role.setAccessCodes',
            {
                id: 11,
                codes: [
                    'U45',
                    'DR7',
                    'SG3_A'
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.role.setAccessCodes',
            [
                'id' => 11,
                'codes' => [
                    'U45',
                    'DR7',
                    'SG3_A',
                ],
            ]
        );
        
        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.setAccessCodes", b24.Params{
        	"id":    11,
        	"codes": []string{"U45", "DR7", "SG3_A"},
        })
        if err != nil {
        	return fmt.Errorf("landing.role.setAccessCodes: %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)
        

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1775067129,
                "finish": 1775067129.196438,
                "duration": 0.19643807411193848,
                "processing": 0,
                "date_start": "2026-04-01T21:12:09+02:00",
                "date_finish": "2026-04-01T21:12:09+02:00",
                "operating_reset_at": 1775067729,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Call result

The method returns true if the request completed without access or system errors.

The value true alone does not confirm that a role with such id exists or that the list of codes was changed.

After invocation, check the result in the interface. You can additionally verify which permissions of the role are applied to the sites via the method landing.role.getRights, but this method does not return the final list of access codes.

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough call parameters, missing: id"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

ACCESS_DENIED

Insufficient permissions to work with the "Sites and Stores" section.

IS_NOT_ADMIN

The method requires administrator rights or "full access" permission to the "Sites and Stores" section.

FEATURE_NOT_AVAIL

Managing permissions in the "Sites and Stores" section is not available on the current plan.

MISSING_PARAMS

The required parameter id is missing.

ERROR_ARGUMENT

The codes parameter is not passed in array format.

ROLE_SCOPE_MISMATCH

The role does not belong to the section specified in the scope parameter. The method returns this error both for a role from another section and for a role that does not exist.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning