Получить названия кодов доступа access.name

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: базовый

Кто может выполнять метод: любой пользователь

Метод access.name получает названия кодов доступа. Коды доступа обозначают пользователей, отделы, группы и другие субъекты прав, например в методе user.access.

Параметры метода

Название
тип

Описание

ACCESS
string[]

Список кодов доступа, названия для которых нужно получить, например ["U1", "D107"].

Основные форматы кодов:

  • U<id> — пользователь, например U1
  • IU<id> — пользователь и его руководители, например IU1
  • G<id> — группа пользователей, например G1
  • D<id> — все сотрудники отдела, например D107
  • DR<id> — все сотрудники отдела и его подотделов, например DR107
  • SG<id>_A, SG<id>_E, SG<id>_K — владелец, модераторы и все участники группы или проекта, например SG1_K
  • AU — все авторизованные пользователи
  • CR — автор

Если параметр не передан, пуст или передан строкой вместо массива, метод вернет false

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "ACCESS": ["G2", "AU"]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/access.name
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "ACCESS": ["G2", "AU"],
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/access.name
// 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

type AccessNameItem = {
  provider: string
  name: string
  provider_id: string
}

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

try {
  const response = await $b24.actions.v2.call.make<AccessNameResult | [] | false>({
    method: 'access.name',
    params: {
      ACCESS: ['G2', 'AU'],
    },
    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(Object.keys(result), 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 getAccessNames() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'access.name',
        params: {
          ACCESS: ['G2', 'AU'],
        },
        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(Object.keys(result), result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getAccessNames)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.access.name(
        access=[
            "G2",
            "AU",
        ],
    ).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(
            'access.name',
            [
                'ACCESS' => ['G2', 'AU']
            ]
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    "access.name",
    {
        "ACCESS": ["G2", "AU"]
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'access.name',
    [
        'ACCESS' => ['G2','AU']
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "access.name", b24.Params{
	"ACCESS": []string{"G2", "AU"},
})
if err != nil {
	return fmt.Errorf("access.name: %w", err)
}

keys, ok := b24.Keys(res.Result)
if !ok {
	return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "G2": {
            "provider": "",
            "name": "Все посетители",
            "provider_id": "other"
        },
        "AU": {
            "provider": "",
            "name": "Все авторизованные пользователи",
            "provider_id": "other"
        }
    },
    "time": {
        "start": 1722002504.2838,
        "finish": 1722002504.32483,
        "duration": 0.0410301685333252,
        "processing": 0.00145506858825684,
        "date_start": "2024-07-26T14:01:44+00:00",
        "date_finish": "2024-07-26T14:01:44+00:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
object|array|boolean

Объект: ключ — код доступа из параметра ACCESS, значение — описание кода (подробное описание).

Если ни одного из переданных кодов нет в Битрикс24, метод вернет пустой массив [].

Если параметр ACCESS не передан, пуст или передан строкой, метод вернет false

time
time

Информация о времени выполнения запроса

Описание кода доступа

Название
тип

Описание

name
string

Название кода доступа на языке Битрикс24, например Все авторизованные пользователи

provider
string

Название поставщика кода доступа на языке Битрикс24, например Пользователь, Отдел, Проект. Для кодов G2, AU и CR — пустая строка

provider_id
string

Идентификатор поставщика кода доступа:

  • user — коды U
  • intranet — коды IU, D, DR
  • group — коды G, кроме G2
  • socnetgroup — коды SG
  • other — коды G2, AU, CR

Коды, которых нет в Битрикс24, например отдел с несуществующим ID, в ответе не возвращаются. Порядок ключей в result может не совпадать с порядком в ACCESS.

Обработка ошибок

Собственных ошибок у метода нет.

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение