Documentation

Users

'Users' ('user') permission

Description

There are several levels of access available via user handling methods to guarantee user personal data security:

  • Access permission restrictions:
    • user_brief allows getting basic information about users, without their contact data and custom fields. This scope is sufficient for scenarios when you need to display user full name within an application UI.
    • user_basic allows getting not only basic information, but also extra Bitrix24 user contact data. This scope is needed for scenarios, associated with calls, email message dispatch performed in your application.

  • Full access versions:
    • user, allows getting all standard fields in addition to allowing to invite new users and updating existing user data.
    • user.userfield opens access to methods for handling user fields (expands list of available fields in methods for reading, included in the abovementioned scopes) for getting, adding, modifying and deleting user fields.
    • Attention! This is a maximum level of access to personal information, extra caution is advised.

Limited user scope versions

These scopes cannot be added/updated user: methods user.add and user.update are unavailable. Only the following fields are available for getting user data in the rest of methods (starting from version 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 scope full version

Full version has the following available fields (starting from version 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

Methods

MethodDescription
user.fields Retrieves list of user field names.
user.current Retrieves current user information.
user.add Invites user.
user.update Updates user information.
user.get Retrieves list of filtered users.
user.search Retrieves list of users with expedited search by personal data.


© «Bitrix24», 2001-2022
Up