> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Объект User

> Поля, типы и условия видимости объектов: User, UserField.

Схемы объектов, возвращаемых методами Guard Forum. Таблицы описывают возможные поля: состав конкретного ответа зависит от прав, контекста, детализации и запрошенных связанных объектов. Отсутствующее поле не следует подменять нулём или пустой строкой.

Имена полей и регистр сохраняются: например, `User` и `user_id` — разные поля. Обозначения типов и пагинация описаны в [обзоре схем](/guard-forum/models.md).

> [!WARNING]
>
> Профиль не имеет одинакового набора полей для всех ключей. Email, дата рождения, группы и настройки видимости зависят от прав и детализации. В Guard Forum `user_title` может иметь тип `true`; `time_spent` добавлен дополнением. Подробнее — [особенности форума](/guard-forum/extensions.md).

## User

| Поле | Тип | Условия | Описание |
| - | - | - | - |
| `about` | `string` | По правам, Подробный ответ | Текст о пользователе |
| `activity_visible` | `boolean` | По правам | Разрешено ли показывать текущую активность |
| `age` | `integer` | Условно | Возраст, если доступен |
| `alert_optout` | `array` | По правам, Подробный ответ | Типы уведомлений, отключённые пользователем |
| `allow_post_profile` | `string` | По правам, Подробный ответ | Правило доступа к публикации в профиле |
| `allow_receive_news_feed` | `string` | По правам, Подробный ответ | Правило доступа к ленте активности |
| `allow_send_personal_conversation` | `string` | По правам, Подробный ответ | Правило отправки личных диалогов |
| `allow_view_identities` | `string` | По правам, Подробный ответ | Правило просмотра контактных данных |
| `allow_view_profile` | `string` | По правам, Подробный ответ | Правило просмотра профиля |
| `avatar_urls` | `object` | По контексту объекта | Адреса аватара по размерам |
| `profile_banner_urls` | `object` | По контексту объекта | Адреса баннера профиля по размерам |
| `can_ban` | `boolean` | По контексту объекта | Может ли текущий пользователь заблокировать пользователя |
| `can_converse` | `boolean` | По контексту объекта | Может ли текущий пользователь начать диалог |
| `can_edit` | `boolean` | По контексту объекта | Может ли текущий пользователь редактировать объект |
| `can_follow` | `boolean` | По контексту объекта | Можно ли подписаться на пользователя |
| `can_ignore` | `boolean` | По контексту объекта | Можно ли игнорировать пользователя |
| `can_post_profile` | `boolean` | По контексту объекта | Можно ли публиковать в профиле |
| `can_view_profile` | `boolean` | По контексту объекта | Можно ли видеть полный профиль |
| `can_view_profile_posts` | `boolean` | По контексту объекта | Можно ли видеть записи профиля |
| `can_warn` | `boolean` | По контексту объекта | Можно ли выдавать предупреждения |
| `content_show_signature` | `boolean` | По правам, Подробный ответ | Показывать ли подписи в содержимом |
| `creation_watch_state` | `string` | По правам, Подробный ответ | Подписка на созданные темы: пустая строка, watch\_no\_email или watch\_email |
| `custom_fields` | `object` | По правам | Значения дополнительных полей; для конфигурации раздела — определения полей |
| `custom_title` | `string` | По правам | Пользовательское звание, если оно задано и доступно по правам |
| `dob` | `object` | По правам | Дата рождения: year, month и day; год может быть null |
| `email` | `string` | По правам, Подробный ответ | Email пользователя; только при соответствующем доступе |
| `email_on_conversation` | `boolean` | По правам, Подробный ответ | Уведомлять ли о диалогах по email |
| `gravatar` | `string` | По правам, Подробный ответ | Настройка Gravatar |
| `interaction_watch_state` | `string` | По правам, Подробный ответ | Подписка после участия: пустая строка, watch\_no\_email или watch\_email |
| `is_admin` | `boolean` | По правам | Является ли пользователь администратором |
| `is_banned` | `boolean` | По правам | Заблокирован ли пользователь |
| `is_discouraged` | `boolean` | По правам | Включён ли режим ограничения пользователя |
| `is_followed` | `boolean` | Условно | Подписан ли текущий пользователь на этого пользователя |
| `is_ignored` | `boolean` | Условно | Игнорирует ли текущий пользователь этого пользователя |
| `is_moderator` | `boolean` | По правам | Является ли пользователь модератором |
| `is_super_admin` | `boolean` | По правам | Является ли пользователь суперадминистратором |
| `last_activity` | `integer` | По правам | Время последней активности, Unix timestamp в секундах |
| `location` | `string` | По контексту объекта | Местоположение из профиля |
| `push_on_conversation` | `boolean` | По правам, Подробный ответ | Включены ли push-уведомления о диалогах |
| `push_optout` | `array` | По правам, Подробный ответ | Отключённые типы push-уведомлений |
| `receive_admin_email` | `boolean` | По правам, Подробный ответ | Разрешены ли письма администрации |
| `secondary_group_ids` | `array` | По правам | ID дополнительных групп |
| `show_dob_date` | `boolean` | По правам, Подробный ответ | Разрешено ли показывать день и месяц рождения |
| `show_dob_year` | `boolean` | По правам, Подробный ответ | Разрешено ли показывать год рождения |
| `signature` | `string` | По контексту объекта | Подпись пользователя |
| `timezone` | `string` | По правам, Подробный ответ | Часовой пояс пользователя |
| `use_tfa` | `boolean` | По правам, Подробный ответ | Включена ли двухфакторная аутентификация |
| `user_group_id` | `integer` | По правам | ID основной группы |
| `user_state` | `string` | По правам | Состояние учётной записи |
| `user_title` | `string или true` | По контексту объекта | Звание; в текущей версии Guard Forum может быть true вместо строки |
| `visible` | `boolean` | По правам | Разрешено ли показывать онлайн-статус |
| `warning_points` | `integer` | По правам | Текущее число баллов предупреждений |
| `website` | `string` | По правам | Сайт пользователя |
| `view_url` | `string` | По контексту объекта | URL объекта на форуме |
| `user_id` | `integer` | По контексту объекта | ID пользователя или автора |
| `username` | `string` | По контексту объекта | Имя автора или пользователя объекта |
| `message_count` | `integer` | По контексту объекта | Число сообщений |
| `question_solution_count` | `integer` | По контексту объекта | Число решений вопросов |
| `register_date` | `integer` | По контексту объекта | Дата регистрации, Unix timestamp в секундах |
| `trophy_points` | `integer` | По контексту объекта | Баллы трофеев |
| `is_staff` | `boolean` | По контексту объекта | Сотрудник ли это форума |
| `reaction_score` | `integer` | По контексту объекта | Суммарный балл реакций |
| `vote_score` | `integer` | По контексту объекта | Суммарный балл голосования за содержимое |
| `time_spent` | `integer` | По контексту объекта | Накопленное время активности в секундах |
| `usa_tfa` | `boolean` | По правам, Подробный ответ | Совместимый устаревший ключ для use\_tfa в XenForo 2.2 |

## UserField

| Поле | Тип | Условия | Описание |
| - | - | - | - |
| `field_id` | `string` | По контексту объекта | Символьный ID дополнительного поля |
| `title` | `string` | По контексту объекта | Название или заголовок |
| `description` | `string` | По контексту объекта | Описание |
| `display_order` | `integer` | По контексту объекта | Порядок отображения |
| `field_type` | `string` | По контексту объекта | Тип поля |
| `field_choices` | `array` | Условно | Доступные варианты выбора с ключами option и name |
| `match_type` | `string` | По контексту объекта | Тип проверки значения |
| `match_params` | `object` | По контексту объекта | Параметры проверки значения |
| `max_length` | `integer` | По контексту объекта | Максимальная длина значения |
| `required` | `boolean` | По контексту объекта | Обязательно ли поле |
| `display_group` | `string` | Условно | Группа отображения поля |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.