Документация для разработчиков
Темная тема

Работа с пользователями

Разрешение Пользователи (user)

Scope: user Права на выполнение: в зависимости от метода

Описание

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

Чтобы гарантировать пользователям безопасность их персональной информации, существует несколько уровней доступа через методы работы с пользователями:

  • Ограниченные версии доступа:
    • user_brief, который позволяет получать базовую информацию о пользователях, без их контактных данных и пользовательских полей. Этот скоуп необходим и достаточен для сценариев, в которых требуется отобразить ФИО пользователя в интерфейсе приложения.
    • user_basic, который позволяет получать не только базовую информацию, но и контактные данные пользователей Битрикс24. Этот скоуп нужен для сценариев, связанных с совершением звонков, или отправкой e-mail сообщений при помощи вашего приложения.

  • Полные версии доступа:
    • user, который позволяет получить все стандартные поля, а кроме того, делает доступной возможность приглашения новых пользователей и изменение данных существующих пользователей.
    • user.userfield, который открывает доступ к методам для работы с пользовательскими полями пользователей (расширяет перечень доступных полей в методах чтения, доступных в скоупах выше) для получения, добавления, изменения и удаления пользовательских полей.
    • Внимание! Это максимальный уровень доступа к персональной информации, запрашивать его нужно очень ответственно.
  • Внимание! Длина имени пользователя не должна превышать 25 символов.

Ограниченные версии скоупа user

В этих скоупах нельзя добавлять/обновлять пользователей: не доступны методы user.add и user.update. Во всех остальных методах получения информации о пользователе доступны только эти поля (с версии Rest 21.600.0):

user_basicuser_brief
  • ID
  • XML_ID
  • ACTIVE
  • NAME
  • LAST_NAME
  • SECOND_NAME
  • TITLE
  • EMAIL
  • PERSONAL_PHONE
  • WORK_PHONE
  • WORK_POSITION
  • WORK_COMPANY
  • IS_ONLINE
  • TIME_ZONE
  • TIMESTAMP_X
  • TIME_ZONE_OFFSET
  • DATE_REGISTER
  • LAST_ACTIVITY_DATE
  • PERSONAL_PROFESSION
  • PERSONAL_GENDER
  • PERSONAL_BIRTHDAY
  • PERSONAL_PHOTO
  • PERSONAL_PHONE
  • PERSONAL_FAX
  • PERSONAL_MOBILE
  • PERSONAL_PAGER
  • PERSONAL_STREET
  • PERSONAL_MAILBOX
  • PERSONAL_CITY
  • PERSONAL_STATE
  • PERSONAL_ZIP
  • PERSONAL_COUNTRY
  • PERSONAL_NOTES
  • WORK_COMPANY
  • WORK_DEPARTMENT
  • WORK_POSITION
  • WORK_WWW
  • WORK_PHONE
  • WORK_FAX
  • WORK_PAGER
  • WORK_STREET
  • WORK_MAILBOX
  • WORK_CITY
  • WORK_STATE
  • WORK_ZIP
  • WORK_COUNTRY
  • WORK_PROFILE
  • WORK_LOGO
  • WORK_NOTES
  • UF_DEPARTMENT
  • UF_DISTRICT
  • UF_SKYPE
  • UF_SKYPE_LINK
  • UF_ZOOM
  • UF_TWITTER
  • UF_FACEBOOK*
  • UF_LINKEDIN
  • UF_XING
  • UF_WEB_SITES
  • UF_PHONE_INNER
  • UF_EMPLOYMENT_DATE
  • UF_TIMEMAN
  • UF_SKILLS
  • UF_INTERESTS
  • ID
  • XML_ID
  • ACTIVE
  • NAME
  • LAST_NAME
  • SECOND_NAME
  • TITLE
  • IS_ONLINE
  • TIME_ZONE
  • TIME_ZONE_OFFSET
  • TIMESTAMP_X
  • DATE_REGISTER
  • PERSONAL_PROFESSION
  • PERSONAL_GENDER
  • PERSONAL_BIRTHDAY
  • PERSONAL_PHOTO
  • PERSONAL_CITY
  • PERSONAL_STATE
  • PERSONAL_COUNTRY
  • WORK_POSITION
  • WORK_CITY
  • WORK_STATE
  • WORK_COUNTRY
  • LAST_ACTIVITY_DATE
  • UF_EMPLOYMENT_DATE
  • UF_TIMEMAN
  • UF_SKILLS
  • UF_INTERESTS
  • UF_DEPARTMENT
  • UF_PHONE_INNER

* Социальная сеть признана экстремистской и запрещена на территории Российской Федерации.

Полная версия скоупа user

В полной версии доступны поля (с версии Rest 21.600.0):

user
  • ID
  • XML_ID
  • ACTIVE
  • NAME
  • LAST_NAME
  • SECOND_NAME
  • TITLE
  • EMAIL
  • LAST_LOGIN
  • DATE_REGISTER
  • TIME_ZONE
  • IS_ONLINE
  • TIME_ZONE_OFFSET
  • TIMESTAMP_X
  • LAST_ACTIVITY_DATE
  • PERSONAL_PROFESSION
  • PERSONAL_GENDER
  • PERSONAL_WWW
  • PERSONAL_BIRTHDAY
  • PERSONAL_PHOTO
  • PERSONAL_ICQ
  • PERSONAL_PHONE
  • PERSONAL_FAX
  • PERSONAL_MOBILE
  • PERSONAL_PAGER
  • PERSONAL_STREET
  • PERSONAL_MAILBOX
  • PERSONAL_CITY
  • PERSONAL_STATE
  • PERSONAL_ZIP
  • PERSONAL_COUNTRY
  • PERSONAL_NOTES
  • WORK_COMPANY
  • WORK_DEPARTMENT
  • WORK_POSITION
  • WORK_WWW
  • WORK_PHONE
  • WORK_FAX
  • WORK_PAGER
  • WORK_STREET
  • WORK_MAILBOX
  • WORK_CITY
  • WORK_STATE
  • WORK_ZIP
  • WORK_COUNTRY
  • WORK_PROFILE
  • WORK_LOGO
  • WORK_NOTES
  • UF_DEPARTMENT
  • UF_DISTRICT
  • UF_SKYPE
  • UF_SKYPE_LINK
  • UF_ZOOM
  • UF_TWITTER
  • UF_FACEBOOK*
  • UF_LINKEDIN
  • UF_XING
  • UF_WEB_SITES
  • UF_PHONE_INNER
  • UF_EMPLOYMENT_DATE
  • UF_TIMEMAN
  • UF_SKILLS
  • UF_INTERESTS

* Социальная сеть признана экстремистской и запрещена на территории Российской Федерации.

Методы

МетодОписание
user.fields Получение списка названий полей пользователя.
user.current Получение информации о текущем пользователе.
user.add Приглашает пользователя.
user.update Обновляет данные пользователя.
user.get Получение фильтрованного списка пользователей.
user.search Получение списка пользователей с ускоренным поиском по персональным данным.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024