Files.com (предварительная версия)

Соединитель Files.com обеспечивает прямую высокопроизводительную интеграцию с Files.com для автоматизированных рабочих процессов и интеграции на платформе автоматизации Майкрософт.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	поддержка Files.com
URL	https://www.files.com/contact
Адрес электронной почты	support@files.com

Метаданные соединителя
Publisher	Files.com
Веб-сайт	https://www.files.com/
Политика конфиденциальности	https://www.files.com/legal/privacy
Категории	Содержимое и файлы;ИТ-операции

соединитель Power Automate Files.com

Обзор

Соединитель Files.com обеспечивает прямую, высокую производительность для Files.com из Microsoft Power Automate и Azure Logic Apps. Files.com — это облачная платформа MFT, SFTP и безопасная платформа общего доступа к файлам, которая заменяет устаревшие серверы одним всегда включено, безопасной структурой. Автоматизируйте критически важные потоки файлов в любом облаке, протоколе или партнере, поддерживая совместную работу человека и устраняя ручную работу.

Примечание. Этот соединитель предоставляет действия только и пока не включает триггеры.

⸻

Предпосылки

Перед использованием этого соединителя убедитесь, что у вас есть: 1. Допустимая учетная запись Files.com с ключом API. 2. Доступ к Microsoft Power Automate.

⸻

Authentication

Этот соединитель использует проверку подлинности ключа API. Ключ API можно создать в учетной записи Files.com в разделе:

Параметры → ключи API → создать ключ API.

При настройке соединителя введите Files.com узел и ключ API в полях проверки подлинности.

Пример:

Узел: ключ API вашей компании: abc123456789...

Все запросы отправляются в:

https://yourcompany.files.com/api/rest/v1/

⸻

Примеры вариантов использования 1. Управление пользователями и группами создание, обновление или отключение пользователей, назначение ролей и управление членством в группах непосредственно с помощью действий Power Automate. 2. Автоматизация рабочих процессов общей ссылки (пакета) создает ссылки общего ресурса для доставки файлов, добавляет получателей, настраивает уведомления или отменяет доступ автоматически. 3. Синхронизация папок списка метаданных файла, получение метаданных файла и применение логики автоматизации, например изменения разрешений или тегов. 4. Создание рабочих процессов подготовки пользователей интегрируют системы управления персоналом или удостоверениями с Files.com для автоматического создания пользователей или обновления доступа при возникновении изменений. 5. Активация распространения документов объединяет действия Files.com с OneDrive или SharePoint для безопасного распространения или архивирования документов.

⸻

Support

Чтобы получить техническую помощь или вопросы о настройке соединителя, обратитесь в службу поддержки Files.com https://www.files.com/contact

Сведения о проблемах с Power Automate см. в документации по пользовательскому соединителю Майкрософт.

⸻

Юридическое уведомление

Этот соединитель предоставляется Files.com. Используя этот соединитель, вы соглашаетесь с условиями обслуживания и политикой конфиденциальности Files.com.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

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

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
ключ API	securestring	Api_key для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Вывод списка папок по пути	Вывод списка папок по пути
Группы списков	Группы списков
Копирование файла или папки	Копирование файла или папки
Обновление группы	Обновление группы
Обновление пользователя	Обновление пользователя
Обновление пользователя	Обновление пользователя
Обновление ссылки на общий доступ	Обновление ссылки на общий доступ
Обновление уведомления по ссылке общего доступа	Обновление уведомления по ссылке общего доступа
Отправка файла	Отправка файла
Перемещение файла или папки	Перемещение файла или папки
Перечисление получателей ссылок общего доступа	Перечисление получателей ссылок общего доступа
Перечисление регистраций ссылок общего ресурса	Перечисление регистраций ссылок общего ресурса
Перечисление скачиваемой ссылки для общего доступа	Перечисление скачиваемой ссылки для общего доступа
Перечисление ссылок общего ресурса	Перечисление ссылок общего ресурса
Перечисление уведомлений ссылок общего доступа	Перечисление уведомлений ссылок общего доступа
Поиск файла или папки по пути	Поиск файла или папки по пути
Показать группу	Показать группу
Показать пользователя	Показать пользователя
Показать ссылку на общий доступ	Показать ссылку на общий доступ
Показать уведомление по ссылке общего доступа	Показать уведомление по ссылке общего доступа
Скачивание файла	Скачивание файла
Создание папки	Создание папки
Создание получателя ссылки общего доступа	Создание получателя ссылки общего доступа
Создание пользователя	Создание пользователя
Создание ссылки на общий доступ	Создание ссылки на общий доступ
Создание уведомления по ссылке общего доступа	Создание уведомления по ссылке общего доступа
Создание учетной записи пользователя для группы	Создание учетной записи пользователя для группы
Создать группу	Создать группу
Список пользователей	Список пользователей
Удаление пользователя	Удаление пользователя
Удаление уведомления по ссылке общего доступа	Удаление уведомления по ссылке общего доступа
Удаление файла или папки	Удаление файла или папки
Удалить группу	Удалить группу
Удалить ссылку на общий ресурс	Удалить ссылку на общий ресурс

Вывод списка папок по пути

Идентификатор операции:

FolderListForPath

Вывод списка папок по пути

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
путь	path	string	Путь к файлу или папке. Это должно быть разделено косой чертой, но оно не должно начинаться или заканчиваться косой чертой. Не более 5000 символов.
created_by_id	created_by_id	integer	Идентификатор пользователя, создавшего файл или папку
created_by_api_key_id	created_by_api_key_id	integer	Идентификатор ключа API, создавшего файл или папку
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	Идентификатор входящего сообщения AS2, создавшего файл или папку
created_by_automation_id	created_by_automation_id	integer	Идентификатор службы автоматизации, создавшего файл или папку
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	Идентификатор регистрации пакета, создавшего файл или папку
created_by_inbox_id	created_by_inbox_id	integer	Идентификатор папки "Входящие", создавшего файл или папку
created_by_remote_server_id	created_by_remote_server_id	integer	Идентификатор удаленного сервера, создавшего файл или папку
created_by_sync_id	created_by_sync_id	integer	Идентификатор синхронизации, создавшего файл или папку
custom_metadata	custom_metadata	object	Настраиваемая карта метаданных ключей и значений. Ограничено 32 ключами, 256 символами на ключ и 1024 символами на значение.
display_name	display_name	string	Отображаемое имя файла или папки
type	type	string	Тип: directory или file.
size	size	integer	Размер файла или папки
создано_в	created_at	string	Дата или время создания файла
last_modified_by_id	last_modified_by_id	integer	Идентификатор пользователя, который последний раз изменил файл или папку
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	Идентификатор ключа API, который последний раз изменил файл или папку
last_modified_by_automation_id	last_modified_by_automation_id	integer	Идентификатор службы автоматизации, которая в последний раз изменила файл или папку
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	Идентификатор регистрации пакета, который последний раз изменил файл или папку
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	Идентификатор удаленного сервера, который последний раз изменил файл или папку
last_modified_by_sync_id	last_modified_by_sync_id	integer	Идентификатор синхронизации, которая в последний раз изменила файл или папку
mtime	mtime	string	В соответствии с сервером файл последней измененной даты или времени. Это метка времени последней операции Files.com файла независимо от того, что было отправлено измененной меткой времени.
provided_mtime	provided_mtime	string	Файл последней измененной даты или времени, в соответствии с клиентом, который его задал. Files.com позволяет клиентам desktop, FTP, SFTP и WebDAV устанавливать изменения одновременно. Это позволяет синхронизации Desktop-Cloud<> сохранять изменения одновременно.
Crc32	crc32	string	Контрольная сумма CRC32. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
md5	md5	string	Контрольная сумма файла MD5. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
sha1	sha1	string	Контрольная сумма SHA1. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
sha256	sha256	string	Файл контрольной суммы SHA256. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
тип MIME	mime_type	string	Тип MIME. Это определяется расширением имени файла и не хранится отдельно.
region	region	string	Расположение региона
permissions	permissions	string	Короткая строка, представляющая разрешения текущего пользователя. Может быть r (чтение), (запись),w (удаление), ld (список) или любое сочетание
subfolders_locked?	subfolders_locked?	boolean	Заблокированы ли вложенные папки и не могут быть изменены?
is_locked	is_locked	boolean	Заблокирована ли эта папка и не может быть изменена?
download_uri	download_uri	string	Ссылка на скачивание файла. Предоставляется только в ответ на запрос скачивания.
priority_color	priority_color	string	Закладка или цвет приоритета файла или папки
preview_id	preview_id	integer	Идентификатор предварительного просмотра файла
id	preview.id	integer	Идентификатор предварительного просмотра
статус	preview.status	string	Состояние предварительного просмотра. Может быть недопустимым, not_generated, создание, завершение или file_too_large
download_uri	preview.download_uri	string	Ссылка на скачивание предварительной версии
type	preview.type	string	Тип предварительного просмотра. Может быть изображение, pdf, pdf_native, видео или звук
size	preview.size	string	Размер предварительного просмотра

Группы списков

Идентификатор операции:

GetGroups

Группы списков

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
id	id	integer	Идентификатор группы
имя	name	string	Имя группы
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
admin_ids	admin_ids	string	Разделенный запятыми список идентификаторов пользователей, которые являются администраторами групп (разделенными запятыми)
заметки	notes	string	Заметки об этой группе
user_ids	user_ids	string	Разделенный запятыми список идентификаторов пользователей, принадлежащих этой группе (разделенных запятыми)
usernames	usernames	string	Разделенный запятыми список имен пользователей, принадлежащих этой группе (разделенных запятыми)
ftp_permission	ftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать FTP для входа. Это переопределит ложное значение ftp_permission на уровне пользователя.
sftp_permission	sftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать SFTP для входа. Это переопределит ложное значение sftp_permission на уровне пользователя.
dav_permission	dav_permission	boolean	Если значение true, пользователи в этой группе могут использовать WebDAV для входа. Это переопределит ложное значение dav_permission на уровне пользователя.
restapi_permission	restapi_permission	boolean	Если значение true, пользователи в этой группе могут использовать REST API для входа. Это переопределит ложное значение restapi_permission на уровне пользователя.
site_id	site_id	integer	Идентификатор сайта

Копирование файла или папки

Идентификатор операции:

FileActionCopy

Копирование файла или папки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.
Место назначения	destination	True	string	Скопируйте путь назначения.

Возвращаемое значение

Имя	Путь	Тип	Описание
статус	status	string	Состояние операции файла.
file_migration_id	file_migration_id	integer	Если состояние ожидается, это идентификатор миграции файлов для проверки обновлений состояния.

Обновление группы

Идентификатор операции:

PatchGroupsId

Обновление группы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор группы.
Идентификаторы администратора	admin_ids		string	Список идентификаторов пользователей администратора группы. При отправке в виде строки следует разделять запятыми.
Имя	name		string	Имя группы.
Примечания.	notes		string	Групповые заметки.
Идентификаторы пользователей	user_ids		string	Список идентификаторов пользователей. При отправке в виде строки следует разделять запятыми.

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор группы
имя	name	string	Имя группы
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
admin_ids	admin_ids	string	Разделенный запятыми список идентификаторов пользователей, которые являются администраторами групп (разделенными запятыми)
заметки	notes	string	Заметки об этой группе
user_ids	user_ids	string	Разделенный запятыми список идентификаторов пользователей, принадлежащих этой группе (разделенных запятыми)
usernames	usernames	string	Разделенный запятыми список имен пользователей, принадлежащих этой группе (разделенных запятыми)
ftp_permission	ftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать FTP для входа. Это переопределит ложное значение ftp_permission на уровне пользователя.
sftp_permission	sftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать SFTP для входа. Это переопределит ложное значение sftp_permission на уровне пользователя.
dav_permission	dav_permission	boolean	Если значение true, пользователи в этой группе могут использовать WebDAV для входа. Это переопределит ложное значение dav_permission на уровне пользователя.
restapi_permission	restapi_permission	boolean	Если значение true, пользователи в этой группе могут использовать REST API для входа. Это переопределит ложное значение restapi_permission на уровне пользователя.
site_id	site_id	integer	Идентификатор сайта

Обновление пользователя

Идентификатор операции:

PatchUser

Обновление пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Метод проверки подлинности	authentication_method		string	Как этот пользователь прошел проверку подлинности?
Компания	company		string	Компания пользователя
Адрес электронной почты	email		string	Электронная почта пользователя.
Идентификаторы группы	group_ids		string	Список идентификаторов группы, с которыми связывается этот пользователь. Разделителя запятыми.
Имя	name		string	Полное имя пользователя
Примечания.	notes		string	Все внутренние заметки пользователя
Пароль	password		string	Пароль пользователя.
Требовать изменение пароля	require_password_change		boolean	Требуется ли изменение пароля при следующем входе пользователя?
Главная страница пользователя	user_home		string	Домашняя папка для FTP/SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Корневой каталог пользователя	user_root		string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Имя пользователя	username		string	Имя пользователя

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор пользователя
username	username	string	Имя пользователя
admin_group_ids	admin_group_ids	array of integer	Список идентификаторов групп, в которых этот пользователь является администратором
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
attachments_permission	attachments_permission	boolean	Если trueпользователь может создавать пакеты (aka Share Links). Используйте вместо этого разрешение пакета.
api_keys_count	api_keys_count	integer	Количество ключей API, связанных с этим пользователем
authenticate_until	authenticate_until	string	Запланированное время или дата, в течение которого пользователь будет деактивирован
authentication_method	authentication_method	string	Как этот пользователь прошел проверку подлинности?
avatar_url	avatar_url	string	URL-адрес, содержащий аватар пользователя
Оплачиваемых	billable	boolean	Это оплачиваемая запись пользователя?
billing_permission	billing_permission	boolean	Разрешить этому пользователю выполнять операции с учетной записью, платежами и счетами?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Разрешить этому пользователю пропускать черные списки IP-адресов на уровне сайта?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Исключите этого пользователя из правил жизненного цикла пользователя?
создано_в	created_at	string	Когда этот пользователь был создан
dav_permission	dav_permission	boolean	Может ли пользователь подключиться к WebDAV?
disabled	disabled	boolean	Отключен ли пользователь? Отключенные пользователи не могут войти в систему и не учитываются в целях выставления счетов. Пользователи могут быть автоматически отключены после периода бездействия с помощью параметра сайта или расписания деактивации после определенной даты.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Вычисляемое свойство, возвращающее значение true, если пользователь отключен или истек или неактивен.
электронная почта	email	string	Адрес электронной почты пользователя
filesystem_layout	filesystem_layout	string	Макет файловой системы
first_login_at	first_login_at	string	Первое время входа пользователя
ftp_permission	ftp_permission	boolean	Может ли пользователь получить доступ с помощью FTP или FTPS?
group_ids	group_ids	string	Разделенный запятыми список идентификаторов групп, в которых этот пользователь является членом
header_text	header_text	string	Текст для отображения пользователю в заголовке пользовательского интерфейса
language	language	string	Предпочитаемый язык
last_login_at	last_login_at	string	Последнее время входа пользователя через любой протокол
last_web_login_at	last_web_login_at	string	Последнее время входа пользователя через веб-сайт
last_ftp_login_at	last_ftp_login_at	string	Последнее время входа пользователя через FTP
last_sftp_login_at	last_sftp_login_at	string	Последнее время входа пользователя через SFTP
last_dav_login_at	last_dav_login_at	string	Последнее время входа пользователя через WebDAV
last_desktop_login_at	last_desktop_login_at	string	Последнее время входа пользователя с помощью классического приложения
last_restapi_login_at	last_restapi_login_at	string	Последнее время входа пользователя через REST API
last_api_use_at	last_api_use_at	string	Последнее время использования API пользователя
last_active_at	last_active_at	string	Последнее время действия пользователя, которое является последним из последних имен входа, последнего использования API, включения или создания
last_protocol_cipher	last_protocol_cipher	string	Самый последний протокол и используемый шифр
lockout_expires	lockout_expires	string	Время в будущем, когда пользователь больше не будет заблокирован, если применимо
имя	name	string	Полное имя пользователя
компания	company	string	Компания пользователя
заметки	notes	string	Все внутренние заметки пользователя
notification_daily_send_time	notification_daily_send_time	integer	Час дня, по которому должны отправляться ежедневные уведомления. Может находиться в диапазоне от 0 до 23
office_integration_enabled	office_integration_enabled	boolean	Включение интеграции с Office для Интернета?
partner_admin	partner_admin	boolean	Является ли этот пользователь администратором партнера?
partner_id	partner_id	integer	Идентификатор партнера, если этот пользователь принадлежит партнеру
partner_name	partner_name	string	Имя партнера, если этот пользователь принадлежит партнеру
password_set_at	password_set_at	string	При последнем настройке пароля пользователя
password_validity_days	password_validity_days	integer	Количество дней, в которых пользователь может использовать тот же пароль.
public_keys_count	public_keys_count	integer	Количество открытых ключей, связанных с этим пользователем
receive_admin_alerts	receive_admin_alerts	boolean	Должен ли пользователь получать оповещения администратора, такие уведомления об истечении срока действия сертификата и превышение срока действия?
require_2fa	require_2fa	string	Обязательный параметр 2FA
require_login_by	require_login_by	string	Требовать, чтобы пользователь входил по указанной дате, в противном случае он будет отключен.
active_2fa	active_2fa	boolean	Активен ли 2fa для пользователя?
require_password_change	require_password_change	boolean	Требуется ли изменение пароля при следующем входе пользователя?
password_expired	password_expired	boolean	Истек срок действия пароля пользователя?
readonly_site_admin	readonly_site_admin	boolean	Разрешено ли пользователю просматривать всю конфигурацию сайта (без выставления счетов) для этого сайта?
restapi_permission	restapi_permission	boolean	Может ли этот пользователь получить доступ к веб-приложению, классическому приложению, пакетам SDK или REST API? (Все эти средства используют API внутри системы, поэтому это один унифицированный набор разрешений.)
self_managed	self_managed	boolean	Управляет ли этот пользователь собственными учетными данными или является ли он общим или ботом?
sftp_permission	sftp_permission	boolean	Может ли пользователь получить доступ с помощью SFTP?
site_admin	site_admin	boolean	Является ли пользователь администратором этого сайта?
site_id	site_id	integer	Идентификатор сайта
skip_welcome_screen	skip_welcome_screen	boolean	Пропустить страницу приветствия в пользовательском интерфейсе?
ssl_required	ssl_required	string	Обязательный параметр SSL
sso_strategy_id	sso_strategy_id	integer	Идентификатор стратегии единого входа (единый вход) для пользователя, если это применимо.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	Подписан ли пользователь на информационный бюллетень?
externally_managed	externally_managed	boolean	Управляется ли этот пользователь SsoStrategy?
tags	tags	string	Разделенный запятыми список тегов для этого пользователя. Теги используются для других функций, таких как UserLifecycleRules, которые могут использовать определенные теги. Теги должны содержать только строчные буквы, цифры и дефисы.
Часовой пояс	time_zone	string	Часовой пояс пользователя
type_of_2fa	type_of_2fa	string	Используемые методы 2FA для программного использования. Будет либо sms, , , totpлибо yubiwebauthnemailнесколько значений отсортированы в алфавитном порядке и присоединены подчеркиванием. Не указывает, имеет ли пользователь несколько из заданного метода.
type_of_2fa_for_display	type_of_2fa_for_display	string	Используемые методы 2FA, отформатированные для отображения в пользовательском интерфейсе. В отличие от type_of_2faэтого значения, это значение будет ясно, если пользователь имеет более 1 одного типа метода.
user_root	user_root	string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
user_home	user_home	string	Домашняя папка для FTP или SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Количество дней, оставшихся до истечения срока действия пароля
password_expire_at	password_expire_at	string	Дата окончания срока действия пароля

Обновление пользователя

Идентификатор операции:

PatchUsersId

Обновление пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	ИД пользователя
Метод проверки подлинности	authentication_method		string	Как этот пользователь прошел проверку подлинности?
Компания	company		string	Компания пользователя
Адрес электронной почты	email		string	Электронная почта пользователя.
Идентификаторы группы	group_ids		string	Список идентификаторов группы, с которыми связывается этот пользователь. Разделителя запятыми.
Имя	name		string	Полное имя пользователя
Примечания.	notes		string	Все внутренние заметки пользователя
Пароль	password		string	Пароль пользователя.
Требовать изменение пароля	require_password_change		boolean	Требуется ли изменение пароля при следующем входе пользователя?
Главная страница пользователя	user_home		string	Домашняя папка для FTP/SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Корневой каталог пользователя	user_root		string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Имя пользователя	username		string	Имя пользователя

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор пользователя
username	username	string	Имя пользователя
admin_group_ids	admin_group_ids	array of integer	Список идентификаторов групп, в которых этот пользователь является администратором
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
attachments_permission	attachments_permission	boolean	Если trueпользователь может создавать пакеты (aka Share Links). Используйте вместо этого разрешение пакета.
api_keys_count	api_keys_count	integer	Количество ключей API, связанных с этим пользователем
authenticate_until	authenticate_until	string	Запланированное время или дата, в течение которого пользователь будет деактивирован
authentication_method	authentication_method	string	Как этот пользователь прошел проверку подлинности?
avatar_url	avatar_url	string	URL-адрес, содержащий аватар пользователя
Оплачиваемых	billable	boolean	Это оплачиваемая запись пользователя?
billing_permission	billing_permission	boolean	Разрешить этому пользователю выполнять операции с учетной записью, платежами и счетами?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Разрешить этому пользователю пропускать черные списки IP-адресов на уровне сайта?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Исключите этого пользователя из правил жизненного цикла пользователя?
создано_в	created_at	string	Когда этот пользователь был создан
dav_permission	dav_permission	boolean	Может ли пользователь подключиться к WebDAV?
disabled	disabled	boolean	Отключен ли пользователь? Отключенные пользователи не могут войти в систему и не учитываются в целях выставления счетов. Пользователи могут быть автоматически отключены после периода бездействия с помощью параметра сайта или расписания деактивации после определенной даты.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Вычисляемое свойство, возвращающее значение true, если пользователь отключен или истек или неактивен.
электронная почта	email	string	Адрес электронной почты пользователя
filesystem_layout	filesystem_layout	string	Макет файловой системы
first_login_at	first_login_at	string	Первое время входа пользователя
ftp_permission	ftp_permission	boolean	Может ли пользователь получить доступ с помощью FTP или FTPS?
group_ids	group_ids	string	Разделенный запятыми список идентификаторов групп, в которых этот пользователь является членом
header_text	header_text	string	Текст для отображения пользователю в заголовке пользовательского интерфейса
language	language	string	Предпочитаемый язык
last_login_at	last_login_at	string	Последнее время входа пользователя через любой протокол
last_web_login_at	last_web_login_at	string	Последнее время входа пользователя через веб-сайт
last_ftp_login_at	last_ftp_login_at	string	Последнее время входа пользователя через FTP
last_sftp_login_at	last_sftp_login_at	string	Последнее время входа пользователя через SFTP
last_dav_login_at	last_dav_login_at	string	Последнее время входа пользователя через WebDAV
last_desktop_login_at	last_desktop_login_at	string	Последнее время входа пользователя с помощью классического приложения
last_restapi_login_at	last_restapi_login_at	string	Последнее время входа пользователя через REST API
last_api_use_at	last_api_use_at	string	Последнее время использования API пользователя
last_active_at	last_active_at	string	Последнее время действия пользователя, которое является последним из последних имен входа, последнего использования API, включения или создания
last_protocol_cipher	last_protocol_cipher	string	Самый последний протокол и используемый шифр
lockout_expires	lockout_expires	string	Время в будущем, когда пользователь больше не будет заблокирован, если применимо
имя	name	string	Полное имя пользователя
компания	company	string	Компания пользователя
заметки	notes	string	Все внутренние заметки пользователя
notification_daily_send_time	notification_daily_send_time	integer	Час дня, по которому должны отправляться ежедневные уведомления. Может находиться в диапазоне от 0 до 23
office_integration_enabled	office_integration_enabled	boolean	Включение интеграции с Office для Интернета?
partner_admin	partner_admin	boolean	Является ли этот пользователь администратором партнера?
partner_id	partner_id	integer	Идентификатор партнера, если этот пользователь принадлежит партнеру
partner_name	partner_name	string	Имя партнера, если этот пользователь принадлежит партнеру
password_set_at	password_set_at	string	При последнем настройке пароля пользователя
password_validity_days	password_validity_days	integer	Количество дней, в которых пользователь может использовать тот же пароль.
public_keys_count	public_keys_count	integer	Количество открытых ключей, связанных с этим пользователем
receive_admin_alerts	receive_admin_alerts	boolean	Должен ли пользователь получать оповещения администратора, такие уведомления об истечении срока действия сертификата и превышение срока действия?
require_2fa	require_2fa	string	Обязательный параметр 2FA
require_login_by	require_login_by	string	Требовать, чтобы пользователь входил по указанной дате, в противном случае он будет отключен.
active_2fa	active_2fa	boolean	Активен ли 2fa для пользователя?
require_password_change	require_password_change	boolean	Требуется ли изменение пароля при следующем входе пользователя?
password_expired	password_expired	boolean	Истек срок действия пароля пользователя?
readonly_site_admin	readonly_site_admin	boolean	Разрешено ли пользователю просматривать всю конфигурацию сайта (без выставления счетов) для этого сайта?
restapi_permission	restapi_permission	boolean	Может ли этот пользователь получить доступ к веб-приложению, классическому приложению, пакетам SDK или REST API? (Все эти средства используют API внутри системы, поэтому это один унифицированный набор разрешений.)
self_managed	self_managed	boolean	Управляет ли этот пользователь собственными учетными данными или является ли он общим или ботом?
sftp_permission	sftp_permission	boolean	Может ли пользователь получить доступ с помощью SFTP?
site_admin	site_admin	boolean	Является ли пользователь администратором этого сайта?
site_id	site_id	integer	Идентификатор сайта
skip_welcome_screen	skip_welcome_screen	boolean	Пропустить страницу приветствия в пользовательском интерфейсе?
ssl_required	ssl_required	string	Обязательный параметр SSL
sso_strategy_id	sso_strategy_id	integer	Идентификатор стратегии единого входа (единый вход) для пользователя, если это применимо.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	Подписан ли пользователь на информационный бюллетень?
externally_managed	externally_managed	boolean	Управляется ли этот пользователь SsoStrategy?
tags	tags	string	Разделенный запятыми список тегов для этого пользователя. Теги используются для других функций, таких как UserLifecycleRules, которые могут использовать определенные теги. Теги должны содержать только строчные буквы, цифры и дефисы.
Часовой пояс	time_zone	string	Часовой пояс пользователя
type_of_2fa	type_of_2fa	string	Используемые методы 2FA для программного использования. Будет либо sms, , , totpлибо yubiwebauthnemailнесколько значений отсортированы в алфавитном порядке и присоединены подчеркиванием. Не указывает, имеет ли пользователь несколько из заданного метода.
type_of_2fa_for_display	type_of_2fa_for_display	string	Используемые методы 2FA, отформатированные для отображения в пользовательском интерфейсе. В отличие от type_of_2faэтого значения, это значение будет ясно, если пользователь имеет более 1 одного типа метода.
user_root	user_root	string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
user_home	user_home	string	Домашняя папка для FTP или SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Количество дней, оставшихся до истечения срока действия пароля
password_expire_at	password_expire_at	string	Дата окончания срока действия пароля

Обновление ссылки на общий доступ

Идентификатор операции:

PatchBundlesId

Обновление ссылки на общий доступ

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор пакета.
Истекает в	expires_at		date-time	Дата и время окончания срока действия пакета

Возвращаемое значение

Имя	Путь	Тип	Описание
код	code	string	Код пакета. Этот код формирует конечную часть общедоступного URL-адреса.
color_left	color_left	string	Ссылка на страницу и цвет кнопки
color_link	color_link	string	Цвет ссылок верхней панели
color_text	color_text	string	Ссылка на страницу и цвет кнопки
color_top	color_top	string	Цвет фона верхней панели
color_top_text	color_top_text	string	Цвет текста верхней панели
URL-адрес	url	string	Общедоступный URL-адрес ссылки на общий доступ
описание	description	string	Общедоступное описание
срок_действия_до	expires_at	string	Дата или время окончания срока действия пакета
password_protected	password_protected	boolean	Защищается ли этот пакет паролем?
permissions	permissions	string	Разрешения, которые применяются к папкам в этой ссылке общего ресурса.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Отображение страницы регистрации, которая записывает имя и адрес электронной почты загрузчика?
require_share_recipient	require_share_recipient	boolean	Разрешить доступ только получателям, которые явно получили общую папку через электронную почту, отправленную через пользовательский интерфейс Files.com?
require_logout	require_logout	boolean	Если задано значение true, мы скроем поле "Запомнить меня" на странице регистрации пакета, требуя, чтобы пользователь выходить из системы и входить обратно при каждом посещении страницы.
clickwrap_body	clickwrap_body	string	Юридический текст, который необходимо согласиться перед доступом к пакету.
id	form_field_set.id	integer	Идентификатор набора полей формы
title	form_field_set.title	string	Заголовок для отображения
form_layout	form_field_set.form_layout	array of integer	Макет формы
form_fields	form_field_set.form_fields	array of object	Связанные поля формы
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без указания имени.
skip_email	form_field_set.skip_email	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления электронной почты.
skip_company	form_field_set.skip_company	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления компании
in_use	form_field_set.in_use	boolean	Набор полей формы используется активным почтовым ящиком или пакетом или регистрацией папки "Входящие" или "Регистрация пакета"
skip_name	skip_name	boolean	Можно сохранить пакетыregistrations без предоставления имени?
skip_email	skip_email	boolean	Можно сохранить пакетыregistrations без предоставления электронной почты?
start_access_on_date	start_access_on_date	string	Дата начала доступа к общей папке. Если nil доступ предоставлен сразу после создания.
skip_company	skip_company	boolean	Можно сохранить пакеты, не предоставляя компании?
id	id	integer	Идентификатор пакета
создано_в	created_at	string	Пакет, созданный в дате или времени
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Не создавайте вложенные папки для файлов, отправленных в эту общую папку. Примечание. Существуют тонкие ошибки безопасности, позволяющие анонимным отправкам от нескольких пользователей жить в одной папке. Мы настоятельно не рекомендуем использовать этот вариант, если это не обязательно.
max_uses	max_uses	integer	Доступ к максимальному количеству пакетов раз
Примечание	note	string	Внутренняя заметка пакета
path_template	path_template	string	Шаблон для создания вложенных папок отправки. Можно использовать имя отправителя, адрес электронной почты, ip, компанию, strftime директивы и любые данные пользовательской формы.
path_template_time_zone	path_template_time_zone	string	Часовой пояс, используемый при отрисовке меток времени в шаблонах путей.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Отправьте квитанцию о доставке в отправитель. Примечание. Только для записываемой общей папки
snapshot_id	snapshot_id	integer	Идентификатор моментального снимка, содержащего содержимое этого пакета.
идентификатор пользователя	user_id	integer	Идентификатор пользователя создателя пакета
username	username	string	Имя пользователя создателя пакета
clickwrap_id	clickwrap_id	integer	Идентификатор clickwrap для использования с этим пакетом.
inbox_id	inbox_id	integer	Идентификатор связанной папки "Входящие", если она доступна.
имя	watermark_attachment.name	string	Имя изображения
УРИ	watermark_attachment.uri	string	URI изображения
watermark_value	watermark_value	object	Предварительный просмотр параметров водяного знака, применяемых ко всем элементам пакета. Использует те же ключи, что и Behavior.value
has_inbox	has_inbox	boolean	Имеет ли этот пакет связанную папку "Входящие"?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Следует ли предотвратить отправку папок?
Пути	paths	array of string	Список путей в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
путь к пакетам	bundlepaths	array of object	Список пакетов в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
items	bundlepaths	object

Обновление уведомления по ссылке общего доступа

Идентификатор операции:

PatchBundleNotificationsId

Обновление уведомления по ссылке общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор уведомления пакета.
Уведомление о регистрации	notify_on_registration		boolean	Активирует уведомление пакета, когда действие регистрации происходит для него.
Уведомление о отправке	notify_on_upload		boolean	Активирует уведомление о пакете при выполнении действия отправки.

Возвращаемое значение

Имя	Путь	Тип	Описание
bundle_id	bundle_id	integer	Идентификатор пакета для уведомления
id	id	integer	Идентификатор уведомления о пакете
notify_on_registration	notify_on_registration	boolean	Активирует уведомление пакета, когда действие регистрации происходит для него.
notify_on_upload	notify_on_upload	boolean	Активирует уведомление о пакете при выполнении действия отправки.
notify_user_id	notify_user_id	integer	Идентификатор пользователя, который нужно уведомить.

Отправка файла

Идентификатор операции:

UploadFile

Отправка файла

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.
Содержимое файла	body	True	binary	Содержимое файла для отправки. Отправьте точные байты, хранящиеся в Files.com.

Перемещение файла или папки

Идентификатор операции:

FileActionMove

Перемещение файла или папки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.
Место назначения	destination	True	string	Переместить путь назначения.

Возвращаемое значение

Имя	Путь	Тип	Описание
статус	status	string	Состояние операции файла.
file_migration_id	file_migration_id	integer	Если состояние ожидается, это идентификатор миграции файлов для проверки обновлений состояния.

Перечисление получателей ссылок общего доступа

Идентификатор операции:

GetBundleRecipients

Перечисление получателей ссылок общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пакета	bundle_id	True	integer	Список получателей пакета с этим идентификатором.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
компания	company	string	Компания получателя.
имя	name	string	Имя получателя.
Примечание	note	string	Заметка, отправленная получателю с пакетом.
получатель;	recipient	string	Адрес электронной почты получателя.
sent_at	sent_at	string	Когда пакет был предоставлен этому получателю.

Перечисление регистраций ссылок общего ресурса

Идентификатор операции:

GetBundleRegistrations

Перечисление регистраций ссылок общего ресурса

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пакета	bundle_id		integer	Идентификатор связанного пакета

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
код	code	string	Код cookie регистрации
имя	name	string	Имя реестра
компания	company	string	Имя компании в реестре
электронная почта	email	string	Адрес электронной почты реестра
протокол IP	ip	string	IP-адрес реестра
inbox_code	inbox_code	string	Код cookie InboxRegistration, если есть связанный код InboxRegistration
clickwrap_body	clickwrap_body	string	Текст Clickwrap, отображаемый реестранту
form_field_set_id	form_field_set_id	integer	Идентификатор связанного набора полей формы
form_field_data	form_field_data	object	Данные для набора полей формы с идентификаторами полей формы в качестве ключей и пользовательских данных в качестве значений
bundle_code	bundle_code	string	Код URL-адреса пакета
bundle_id	bundle_id	integer	Идентификатор связанного пакета
bundle_recipient_id	bundle_recipient_id	integer	Идентификатор связанного получателя пакета
создано_в	created_at	string	Дата или время создания регистрации

Перечисление скачиваемой ссылки для общего доступа

Идентификатор операции:

GetBundleDownloads

Перечисление скачиваемой ссылки для общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пакета	bundle_id		integer	Идентификатор пакета

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
код	bundle_registration.code	string	Код cookie регистрации
имя	bundle_registration.name	string	Имя реестра
компания	bundle_registration.company	string	Имя компании в реестре
электронная почта	bundle_registration.email	string	Адрес электронной почты реестра
протокол IP	bundle_registration.ip	string	IP-адрес реестра
inbox_code	bundle_registration.inbox_code	string	Код cookie InboxRegistration, если есть связанный код InboxRegistration
clickwrap_body	bundle_registration.clickwrap_body	string	Текст Clickwrap, отображаемый реестранту
form_field_set_id	bundle_registration.form_field_set_id	integer	Идентификатор связанного набора полей формы
form_field_data	bundle_registration.form_field_data	object	Данные для набора полей формы с идентификаторами полей формы в качестве ключей и пользовательских данных в качестве значений
bundle_code	bundle_registration.bundle_code	string	Код URL-адреса пакета
bundle_id	bundle_registration.bundle_id	integer	Идентификатор связанного пакета
bundle_recipient_id	bundle_registration.bundle_recipient_id	integer	Идентификатор связанного получателя пакета
создано_в	bundle_registration.created_at	string	Дата или время создания регистрации
download_method	download_method	string	Метод скачивания (файл или full_zip)
путь	path	string	Путь скачивания. Это должно быть разделено косой чертой, но оно не должно начинаться или заканчиваться косой чертой. Не более 5000 символов.
создано_в	created_at	string	Скачивание даты или времени

Перечисление ссылок общего ресурса

Идентификатор операции:

GetBundles

Перечисление ссылок общего ресурса

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
код	code	string	Код пакета. Этот код формирует конечную часть общедоступного URL-адреса.
color_left	color_left	string	Ссылка на страницу и цвет кнопки
color_link	color_link	string	Цвет ссылок верхней панели
color_text	color_text	string	Ссылка на страницу и цвет кнопки
color_top	color_top	string	Цвет фона верхней панели
color_top_text	color_top_text	string	Цвет текста верхней панели
URL-адрес	url	string	Общедоступный URL-адрес ссылки на общий доступ
описание	description	string	Общедоступное описание
срок_действия_до	expires_at	string	Дата или время окончания срока действия пакета
password_protected	password_protected	boolean	Защищается ли этот пакет паролем?
permissions	permissions	string	Разрешения, которые применяются к папкам в этой ссылке общего ресурса.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Отображение страницы регистрации, которая записывает имя и адрес электронной почты загрузчика?
require_share_recipient	require_share_recipient	boolean	Разрешить доступ только получателям, которые явно получили общую папку через электронную почту, отправленную через пользовательский интерфейс Files.com?
require_logout	require_logout	boolean	Если задано значение true, мы скроем поле "Запомнить меня" на странице регистрации пакета, требуя, чтобы пользователь выходить из системы и входить обратно при каждом посещении страницы.
clickwrap_body	clickwrap_body	string	Юридический текст, который необходимо согласиться перед доступом к пакету.
id	form_field_set.id	integer	Идентификатор набора полей формы
title	form_field_set.title	string	Заголовок для отображения
form_layout	form_field_set.form_layout	array of integer	Макет формы
form_fields	form_field_set.form_fields	array of object	Связанные поля формы
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без указания имени.
skip_email	form_field_set.skip_email	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления электронной почты.
skip_company	form_field_set.skip_company	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления компании
in_use	form_field_set.in_use	boolean	Набор полей формы используется активным почтовым ящиком или пакетом или регистрацией папки "Входящие" или "Регистрация пакета"
skip_name	skip_name	boolean	Можно сохранить пакетыregistrations без предоставления имени?
skip_email	skip_email	boolean	Можно сохранить пакетыregistrations без предоставления электронной почты?
start_access_on_date	start_access_on_date	string	Дата начала доступа к общей папке. Если nil доступ предоставлен сразу после создания.
skip_company	skip_company	boolean	Можно сохранить пакеты, не предоставляя компании?
id	id	integer	Идентификатор пакета
создано_в	created_at	string	Пакет, созданный в дате или времени
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Не создавайте вложенные папки для файлов, отправленных в эту общую папку. Примечание. Существуют тонкие ошибки безопасности, позволяющие анонимным отправкам от нескольких пользователей жить в одной папке. Мы настоятельно не рекомендуем использовать этот вариант, если это не обязательно.
max_uses	max_uses	integer	Доступ к максимальному количеству пакетов раз
Примечание	note	string	Внутренняя заметка пакета
path_template	path_template	string	Шаблон для создания вложенных папок отправки. Можно использовать имя отправителя, адрес электронной почты, ip, компанию, strftime директивы и любые данные пользовательской формы.
path_template_time_zone	path_template_time_zone	string	Часовой пояс, используемый при отрисовке меток времени в шаблонах путей.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Отправьте квитанцию о доставке в отправитель. Примечание. Только для записываемой общей папки
snapshot_id	snapshot_id	integer	Идентификатор моментального снимка, содержащего содержимое этого пакета.
идентификатор пользователя	user_id	integer	Идентификатор пользователя создателя пакета
username	username	string	Имя пользователя создателя пакета
clickwrap_id	clickwrap_id	integer	Идентификатор clickwrap для использования с этим пакетом.
inbox_id	inbox_id	integer	Идентификатор связанной папки "Входящие", если она доступна.
имя	watermark_attachment.name	string	Имя изображения
УРИ	watermark_attachment.uri	string	URI изображения
watermark_value	watermark_value	object	Предварительный просмотр параметров водяного знака, применяемых ко всем элементам пакета. Использует те же ключи, что и Behavior.value
has_inbox	has_inbox	boolean	Имеет ли этот пакет связанную папку "Входящие"?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Следует ли предотвратить отправку папок?
Пути	paths	array of string	Список путей в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
путь к пакетам	bundlepaths	array of object	Список пакетов в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
items	bundlepaths	object

Перечисление уведомлений ссылок общего доступа

Идентификатор операции:

GetBundleNotifications

Перечисление уведомлений ссылок общего доступа

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
bundle_id	bundle_id	integer	Идентификатор пакета для уведомления
id	id	integer	Идентификатор уведомления о пакете
notify_on_registration	notify_on_registration	boolean	Активирует уведомление пакета, когда действие регистрации происходит для него.
notify_on_upload	notify_on_upload	boolean	Активирует уведомление о пакете при выполнении действия отправки.
notify_user_id	notify_user_id	integer	Идентификатор пользователя, который нужно уведомить.

Поиск файла или папки по пути

Идентификатор операции:

FileActionFind

Поиск файла или папки по пути

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.

Возвращаемое значение

Имя	Путь	Тип	Описание
путь	path	string	Путь к файлу или папке. Это должно быть разделено косой чертой, но оно не должно начинаться или заканчиваться косой чертой. Не более 5000 символов.
created_by_id	created_by_id	integer	Идентификатор пользователя, создавшего файл или папку
created_by_api_key_id	created_by_api_key_id	integer	Идентификатор ключа API, создавшего файл или папку
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	Идентификатор входящего сообщения AS2, создавшего файл или папку
created_by_automation_id	created_by_automation_id	integer	Идентификатор службы автоматизации, создавшего файл или папку
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	Идентификатор регистрации пакета, создавшего файл или папку
created_by_inbox_id	created_by_inbox_id	integer	Идентификатор папки "Входящие", создавшего файл или папку
created_by_remote_server_id	created_by_remote_server_id	integer	Идентификатор удаленного сервера, создавшего файл или папку
created_by_sync_id	created_by_sync_id	integer	Идентификатор синхронизации, создавшего файл или папку
custom_metadata	custom_metadata	object	Настраиваемая карта метаданных ключей и значений. Ограничено 32 ключами, 256 символами на ключ и 1024 символами на значение.
display_name	display_name	string	Отображаемое имя файла или папки
type	type	string	Тип: directory или file.
size	size	integer	Размер файла или папки
создано_в	created_at	string	Дата или время создания файла
last_modified_by_id	last_modified_by_id	integer	Идентификатор пользователя, который последний раз изменил файл или папку
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	Идентификатор ключа API, который последний раз изменил файл или папку
last_modified_by_automation_id	last_modified_by_automation_id	integer	Идентификатор службы автоматизации, которая в последний раз изменила файл или папку
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	Идентификатор регистрации пакета, который последний раз изменил файл или папку
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	Идентификатор удаленного сервера, который последний раз изменил файл или папку
last_modified_by_sync_id	last_modified_by_sync_id	integer	Идентификатор синхронизации, которая в последний раз изменила файл или папку
mtime	mtime	string	В соответствии с сервером файл последней измененной даты или времени. Это метка времени последней операции Files.com файла независимо от того, что было отправлено измененной меткой времени.
provided_mtime	provided_mtime	string	Файл последней измененной даты или времени, в соответствии с клиентом, который его задал. Files.com позволяет клиентам desktop, FTP, SFTP и WebDAV устанавливать изменения одновременно. Это позволяет синхронизации Desktop-Cloud<> сохранять изменения одновременно.
Crc32	crc32	string	Контрольная сумма CRC32. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
md5	md5	string	Контрольная сумма файла MD5. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
sha1	sha1	string	Контрольная сумма SHA1. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
sha256	sha256	string	Файл контрольной суммы SHA256. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
тип MIME	mime_type	string	Тип MIME. Это определяется расширением имени файла и не хранится отдельно.
region	region	string	Расположение региона
permissions	permissions	string	Короткая строка, представляющая разрешения текущего пользователя. Может быть r (чтение), (запись),w (удаление), ld (список) или любое сочетание
subfolders_locked?	subfolders_locked?	boolean	Заблокированы ли вложенные папки и не могут быть изменены?
is_locked	is_locked	boolean	Заблокирована ли эта папка и не может быть изменена?
download_uri	download_uri	string	Ссылка на скачивание файла. Предоставляется только в ответ на запрос скачивания.
priority_color	priority_color	string	Закладка или цвет приоритета файла или папки
preview_id	preview_id	integer	Идентификатор предварительного просмотра файла
id	preview.id	integer	Идентификатор предварительного просмотра
статус	preview.status	string	Состояние предварительного просмотра. Может быть недопустимым, not_generated, создание, завершение или file_too_large
download_uri	preview.download_uri	string	Ссылка на скачивание предварительной версии
type	preview.type	string	Тип предварительного просмотра. Может быть изображение, pdf, pdf_native, видео или звук
size	preview.size	string	Размер предварительного просмотра

Показать группу

Идентификатор операции:

GetGroupsId

Показать группу

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор группы.

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор группы
имя	name	string	Имя группы
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
admin_ids	admin_ids	string	Разделенный запятыми список идентификаторов пользователей, которые являются администраторами групп (разделенными запятыми)
заметки	notes	string	Заметки об этой группе
user_ids	user_ids	string	Разделенный запятыми список идентификаторов пользователей, принадлежащих этой группе (разделенных запятыми)
usernames	usernames	string	Разделенный запятыми список имен пользователей, принадлежащих этой группе (разделенных запятыми)
ftp_permission	ftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать FTP для входа. Это переопределит ложное значение ftp_permission на уровне пользователя.
sftp_permission	sftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать SFTP для входа. Это переопределит ложное значение sftp_permission на уровне пользователя.
dav_permission	dav_permission	boolean	Если значение true, пользователи в этой группе могут использовать WebDAV для входа. Это переопределит ложное значение dav_permission на уровне пользователя.
restapi_permission	restapi_permission	boolean	Если значение true, пользователи в этой группе могут использовать REST API для входа. Это переопределит ложное значение restapi_permission на уровне пользователя.
site_id	site_id	integer	Идентификатор сайта

Показать пользователя

Идентификатор операции:

GetUsersId

Показать пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	ИД пользователя

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор пользователя
username	username	string	Имя пользователя
admin_group_ids	admin_group_ids	array of integer	Список идентификаторов групп, в которых этот пользователь является администратором
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
attachments_permission	attachments_permission	boolean	Если trueпользователь может создавать пакеты (aka Share Links). Используйте вместо этого разрешение пакета.
api_keys_count	api_keys_count	integer	Количество ключей API, связанных с этим пользователем
authenticate_until	authenticate_until	string	Запланированное время или дата, в течение которого пользователь будет деактивирован
authentication_method	authentication_method	string	Как этот пользователь прошел проверку подлинности?
avatar_url	avatar_url	string	URL-адрес, содержащий аватар пользователя
Оплачиваемых	billable	boolean	Это оплачиваемая запись пользователя?
billing_permission	billing_permission	boolean	Разрешить этому пользователю выполнять операции с учетной записью, платежами и счетами?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Разрешить этому пользователю пропускать черные списки IP-адресов на уровне сайта?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Исключите этого пользователя из правил жизненного цикла пользователя?
создано_в	created_at	string	Когда этот пользователь был создан
dav_permission	dav_permission	boolean	Может ли пользователь подключиться к WebDAV?
disabled	disabled	boolean	Отключен ли пользователь? Отключенные пользователи не могут войти в систему и не учитываются в целях выставления счетов. Пользователи могут быть автоматически отключены после периода бездействия с помощью параметра сайта или расписания деактивации после определенной даты.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Вычисляемое свойство, возвращающее значение true, если пользователь отключен или истек или неактивен.
электронная почта	email	string	Адрес электронной почты пользователя
filesystem_layout	filesystem_layout	string	Макет файловой системы
first_login_at	first_login_at	string	Первое время входа пользователя
ftp_permission	ftp_permission	boolean	Может ли пользователь получить доступ с помощью FTP или FTPS?
group_ids	group_ids	string	Разделенный запятыми список идентификаторов групп, в которых этот пользователь является членом
header_text	header_text	string	Текст для отображения пользователю в заголовке пользовательского интерфейса
language	language	string	Предпочитаемый язык
last_login_at	last_login_at	string	Последнее время входа пользователя через любой протокол
last_web_login_at	last_web_login_at	string	Последнее время входа пользователя через веб-сайт
last_ftp_login_at	last_ftp_login_at	string	Последнее время входа пользователя через FTP
last_sftp_login_at	last_sftp_login_at	string	Последнее время входа пользователя через SFTP
last_dav_login_at	last_dav_login_at	string	Последнее время входа пользователя через WebDAV
last_desktop_login_at	last_desktop_login_at	string	Последнее время входа пользователя с помощью классического приложения
last_restapi_login_at	last_restapi_login_at	string	Последнее время входа пользователя через REST API
last_api_use_at	last_api_use_at	string	Последнее время использования API пользователя
last_active_at	last_active_at	string	Последнее время действия пользователя, которое является последним из последних имен входа, последнего использования API, включения или создания
last_protocol_cipher	last_protocol_cipher	string	Самый последний протокол и используемый шифр
lockout_expires	lockout_expires	string	Время в будущем, когда пользователь больше не будет заблокирован, если применимо
имя	name	string	Полное имя пользователя
компания	company	string	Компания пользователя
заметки	notes	string	Все внутренние заметки пользователя
notification_daily_send_time	notification_daily_send_time	integer	Час дня, по которому должны отправляться ежедневные уведомления. Может находиться в диапазоне от 0 до 23
office_integration_enabled	office_integration_enabled	boolean	Включение интеграции с Office для Интернета?
partner_admin	partner_admin	boolean	Является ли этот пользователь администратором партнера?
partner_id	partner_id	integer	Идентификатор партнера, если этот пользователь принадлежит партнеру
partner_name	partner_name	string	Имя партнера, если этот пользователь принадлежит партнеру
password_set_at	password_set_at	string	При последнем настройке пароля пользователя
password_validity_days	password_validity_days	integer	Количество дней, в которых пользователь может использовать тот же пароль.
public_keys_count	public_keys_count	integer	Количество открытых ключей, связанных с этим пользователем
receive_admin_alerts	receive_admin_alerts	boolean	Должен ли пользователь получать оповещения администратора, такие уведомления об истечении срока действия сертификата и превышение срока действия?
require_2fa	require_2fa	string	Обязательный параметр 2FA
require_login_by	require_login_by	string	Требовать, чтобы пользователь входил по указанной дате, в противном случае он будет отключен.
active_2fa	active_2fa	boolean	Активен ли 2fa для пользователя?
require_password_change	require_password_change	boolean	Требуется ли изменение пароля при следующем входе пользователя?
password_expired	password_expired	boolean	Истек срок действия пароля пользователя?
readonly_site_admin	readonly_site_admin	boolean	Разрешено ли пользователю просматривать всю конфигурацию сайта (без выставления счетов) для этого сайта?
restapi_permission	restapi_permission	boolean	Может ли этот пользователь получить доступ к веб-приложению, классическому приложению, пакетам SDK или REST API? (Все эти средства используют API внутри системы, поэтому это один унифицированный набор разрешений.)
self_managed	self_managed	boolean	Управляет ли этот пользователь собственными учетными данными или является ли он общим или ботом?
sftp_permission	sftp_permission	boolean	Может ли пользователь получить доступ с помощью SFTP?
site_admin	site_admin	boolean	Является ли пользователь администратором этого сайта?
site_id	site_id	integer	Идентификатор сайта
skip_welcome_screen	skip_welcome_screen	boolean	Пропустить страницу приветствия в пользовательском интерфейсе?
ssl_required	ssl_required	string	Обязательный параметр SSL
sso_strategy_id	sso_strategy_id	integer	Идентификатор стратегии единого входа (единый вход) для пользователя, если это применимо.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	Подписан ли пользователь на информационный бюллетень?
externally_managed	externally_managed	boolean	Управляется ли этот пользователь SsoStrategy?
tags	tags	string	Разделенный запятыми список тегов для этого пользователя. Теги используются для других функций, таких как UserLifecycleRules, которые могут использовать определенные теги. Теги должны содержать только строчные буквы, цифры и дефисы.
Часовой пояс	time_zone	string	Часовой пояс пользователя
type_of_2fa	type_of_2fa	string	Используемые методы 2FA для программного использования. Будет либо sms, , , totpлибо yubiwebauthnemailнесколько значений отсортированы в алфавитном порядке и присоединены подчеркиванием. Не указывает, имеет ли пользователь несколько из заданного метода.
type_of_2fa_for_display	type_of_2fa_for_display	string	Используемые методы 2FA, отформатированные для отображения в пользовательском интерфейсе. В отличие от type_of_2faэтого значения, это значение будет ясно, если пользователь имеет более 1 одного типа метода.
user_root	user_root	string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
user_home	user_home	string	Домашняя папка для FTP или SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Количество дней, оставшихся до истечения срока действия пароля
password_expire_at	password_expire_at	string	Дата окончания срока действия пароля

Показать ссылку на общий доступ

Идентификатор операции:

GetBundlesId

Показать ссылку на общий доступ

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор пакета.

Возвращаемое значение

Имя	Путь	Тип	Описание
код	code	string	Код пакета. Этот код формирует конечную часть общедоступного URL-адреса.
color_left	color_left	string	Ссылка на страницу и цвет кнопки
color_link	color_link	string	Цвет ссылок верхней панели
color_text	color_text	string	Ссылка на страницу и цвет кнопки
color_top	color_top	string	Цвет фона верхней панели
color_top_text	color_top_text	string	Цвет текста верхней панели
URL-адрес	url	string	Общедоступный URL-адрес ссылки на общий доступ
описание	description	string	Общедоступное описание
срок_действия_до	expires_at	string	Дата или время окончания срока действия пакета
password_protected	password_protected	boolean	Защищается ли этот пакет паролем?
permissions	permissions	string	Разрешения, которые применяются к папкам в этой ссылке общего ресурса.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Отображение страницы регистрации, которая записывает имя и адрес электронной почты загрузчика?
require_share_recipient	require_share_recipient	boolean	Разрешить доступ только получателям, которые явно получили общую папку через электронную почту, отправленную через пользовательский интерфейс Files.com?
require_logout	require_logout	boolean	Если задано значение true, мы скроем поле "Запомнить меня" на странице регистрации пакета, требуя, чтобы пользователь выходить из системы и входить обратно при каждом посещении страницы.
clickwrap_body	clickwrap_body	string	Юридический текст, который необходимо согласиться перед доступом к пакету.
id	form_field_set.id	integer	Идентификатор набора полей формы
title	form_field_set.title	string	Заголовок для отображения
form_layout	form_field_set.form_layout	array of integer	Макет формы
form_fields	form_field_set.form_fields	array of object	Связанные поля формы
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без указания имени.
skip_email	form_field_set.skip_email	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления электронной почты.
skip_company	form_field_set.skip_company	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления компании
in_use	form_field_set.in_use	boolean	Набор полей формы используется активным почтовым ящиком или пакетом или регистрацией папки "Входящие" или "Регистрация пакета"
skip_name	skip_name	boolean	Можно сохранить пакетыregistrations без предоставления имени?
skip_email	skip_email	boolean	Можно сохранить пакетыregistrations без предоставления электронной почты?
start_access_on_date	start_access_on_date	string	Дата начала доступа к общей папке. Если nil доступ предоставлен сразу после создания.
skip_company	skip_company	boolean	Можно сохранить пакеты, не предоставляя компании?
id	id	integer	Идентификатор пакета
создано_в	created_at	string	Пакет, созданный в дате или времени
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Не создавайте вложенные папки для файлов, отправленных в эту общую папку. Примечание. Существуют тонкие ошибки безопасности, позволяющие анонимным отправкам от нескольких пользователей жить в одной папке. Мы настоятельно не рекомендуем использовать этот вариант, если это не обязательно.
max_uses	max_uses	integer	Доступ к максимальному количеству пакетов раз
Примечание	note	string	Внутренняя заметка пакета
path_template	path_template	string	Шаблон для создания вложенных папок отправки. Можно использовать имя отправителя, адрес электронной почты, ip, компанию, strftime директивы и любые данные пользовательской формы.
path_template_time_zone	path_template_time_zone	string	Часовой пояс, используемый при отрисовке меток времени в шаблонах путей.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Отправьте квитанцию о доставке в отправитель. Примечание. Только для записываемой общей папки
snapshot_id	snapshot_id	integer	Идентификатор моментального снимка, содержащего содержимое этого пакета.
идентификатор пользователя	user_id	integer	Идентификатор пользователя создателя пакета
username	username	string	Имя пользователя создателя пакета
clickwrap_id	clickwrap_id	integer	Идентификатор clickwrap для использования с этим пакетом.
inbox_id	inbox_id	integer	Идентификатор связанной папки "Входящие", если она доступна.
имя	watermark_attachment.name	string	Имя изображения
УРИ	watermark_attachment.uri	string	URI изображения
watermark_value	watermark_value	object	Предварительный просмотр параметров водяного знака, применяемых ко всем элементам пакета. Использует те же ключи, что и Behavior.value
has_inbox	has_inbox	boolean	Имеет ли этот пакет связанную папку "Входящие"?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Следует ли предотвратить отправку папок?
Пути	paths	array of string	Список путей в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
путь к пакетам	bundlepaths	array of object	Список пакетов в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
items	bundlepaths	object

Показать уведомление по ссылке общего доступа

Идентификатор операции:

GetBundleNotificationsId

Показать уведомление по ссылке общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор уведомления пакета.

Возвращаемое значение

Имя	Путь	Тип	Описание
bundle_id	bundle_id	integer	Идентификатор пакета для уведомления
id	id	integer	Идентификатор уведомления о пакете
notify_on_registration	notify_on_registration	boolean	Активирует уведомление пакета, когда действие регистрации происходит для него.
notify_on_upload	notify_on_upload	boolean	Активирует уведомление о пакете при выполнении действия отправки.
notify_user_id	notify_user_id	integer	Идентификатор пользователя, который нужно уведомить.

Скачивание файла

Идентификатор операции:

DownloadFile

Скачивание файла

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.

Возвращаемое значение

Содержимое файла

binary

Создание папки

Идентификатор операции:

PostFoldersPath

Создание папки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.

Возвращаемое значение

Имя	Путь	Тип	Описание
путь	path	string	Путь к файлу или папке. Это должно быть разделено косой чертой, но оно не должно начинаться или заканчиваться косой чертой. Не более 5000 символов.
created_by_id	created_by_id	integer	Идентификатор пользователя, создавшего файл или папку
created_by_api_key_id	created_by_api_key_id	integer	Идентификатор ключа API, создавшего файл или папку
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	Идентификатор входящего сообщения AS2, создавшего файл или папку
created_by_automation_id	created_by_automation_id	integer	Идентификатор службы автоматизации, создавшего файл или папку
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	Идентификатор регистрации пакета, создавшего файл или папку
created_by_inbox_id	created_by_inbox_id	integer	Идентификатор папки "Входящие", создавшего файл или папку
created_by_remote_server_id	created_by_remote_server_id	integer	Идентификатор удаленного сервера, создавшего файл или папку
created_by_sync_id	created_by_sync_id	integer	Идентификатор синхронизации, создавшего файл или папку
custom_metadata	custom_metadata	object	Настраиваемая карта метаданных ключей и значений. Ограничено 32 ключами, 256 символами на ключ и 1024 символами на значение.
display_name	display_name	string	Отображаемое имя файла или папки
type	type	string	Тип: directory или file.
size	size	integer	Размер файла или папки
создано_в	created_at	string	Дата или время создания файла
last_modified_by_id	last_modified_by_id	integer	Идентификатор пользователя, который последний раз изменил файл или папку
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	Идентификатор ключа API, который последний раз изменил файл или папку
last_modified_by_automation_id	last_modified_by_automation_id	integer	Идентификатор службы автоматизации, которая в последний раз изменила файл или папку
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	Идентификатор регистрации пакета, который последний раз изменил файл или папку
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	Идентификатор удаленного сервера, который последний раз изменил файл или папку
last_modified_by_sync_id	last_modified_by_sync_id	integer	Идентификатор синхронизации, которая в последний раз изменила файл или папку
mtime	mtime	string	В соответствии с сервером файл последней измененной даты или времени. Это метка времени последней операции Files.com файла независимо от того, что было отправлено измененной меткой времени.
provided_mtime	provided_mtime	string	Файл последней измененной даты или времени, в соответствии с клиентом, который его задал. Files.com позволяет клиентам desktop, FTP, SFTP и WebDAV устанавливать изменения одновременно. Это позволяет синхронизации Desktop-Cloud<> сохранять изменения одновременно.
Crc32	crc32	string	Контрольная сумма CRC32. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
md5	md5	string	Контрольная сумма файла MD5. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
sha1	sha1	string	Контрольная сумма SHA1. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
sha256	sha256	string	Файл контрольной суммы SHA256. Иногда это отложено, поэтому если вы получите пустой ответ, подождите и повторите попытку.
тип MIME	mime_type	string	Тип MIME. Это определяется расширением имени файла и не хранится отдельно.
region	region	string	Расположение региона
permissions	permissions	string	Короткая строка, представляющая разрешения текущего пользователя. Может быть r (чтение), (запись),w (удаление), ld (список) или любое сочетание
subfolders_locked?	subfolders_locked?	boolean	Заблокированы ли вложенные папки и не могут быть изменены?
is_locked	is_locked	boolean	Заблокирована ли эта папка и не может быть изменена?
download_uri	download_uri	string	Ссылка на скачивание файла. Предоставляется только в ответ на запрос скачивания.
priority_color	priority_color	string	Закладка или цвет приоритета файла или папки
preview_id	preview_id	integer	Идентификатор предварительного просмотра файла
id	preview.id	integer	Идентификатор предварительного просмотра
статус	preview.status	string	Состояние предварительного просмотра. Может быть недопустимым, not_generated, создание, завершение или file_too_large
download_uri	preview.download_uri	string	Ссылка на скачивание предварительной версии
type	preview.type	string	Тип предварительного просмотра. Может быть изображение, pdf, pdf_native, видео или звук
size	preview.size	string	Размер предварительного просмотра

Создание получателя ссылки общего доступа

Идентификатор операции:

PostBundleRecipients

Создание получателя ссылки общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пакета	bundle_id	True	integer	Пакет для общего доступа.
Компания	company		string	Компания получателя.
Имя	name		string	Имя получателя.
Замечание	note		string	Обратите внимание на включение в электронную почту.
Recipient	recipient	True	string	Адреса электронной почты для совместного использования этого пакета.

Возвращаемое значение

Имя	Путь	Тип	Описание
компания	company	string	Компания получателя.
имя	name	string	Имя получателя.
Примечание	note	string	Заметка, отправленная получателю с пакетом.
получатель;	recipient	string	Адрес электронной почты получателя.
sent_at	sent_at	string	Когда пакет был предоставлен этому получателю.

Создание пользователя

Идентификатор операции:

PostUsers

Создание пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Метод проверки подлинности	authentication_method		string	Как этот пользователь прошел проверку подлинности?
Компания	company		string	Компания пользователя
Адрес электронной почты	email		string	Электронная почта пользователя.
Идентификаторы группы	group_ids		string	Список идентификаторов группы, с которыми связывается этот пользователь. Разделителя запятыми.
Имя	name		string	Полное имя пользователя
Примечания.	notes		string	Все внутренние заметки пользователя
Пароль	password		string	Пароль пользователя.
Требовать изменение пароля	require_password_change		boolean	Требуется ли изменение пароля при следующем входе пользователя?
Главная страница пользователя	user_home		string	Домашняя папка для FTP/SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Корневой каталог пользователя	user_root		string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Имя пользователя	username	True	string	Имя пользователя

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор пользователя
username	username	string	Имя пользователя
admin_group_ids	admin_group_ids	array of integer	Список идентификаторов групп, в которых этот пользователь является администратором
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
attachments_permission	attachments_permission	boolean	Если trueпользователь может создавать пакеты (aka Share Links). Используйте вместо этого разрешение пакета.
api_keys_count	api_keys_count	integer	Количество ключей API, связанных с этим пользователем
authenticate_until	authenticate_until	string	Запланированное время или дата, в течение которого пользователь будет деактивирован
authentication_method	authentication_method	string	Как этот пользователь прошел проверку подлинности?
avatar_url	avatar_url	string	URL-адрес, содержащий аватар пользователя
Оплачиваемых	billable	boolean	Это оплачиваемая запись пользователя?
billing_permission	billing_permission	boolean	Разрешить этому пользователю выполнять операции с учетной записью, платежами и счетами?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Разрешить этому пользователю пропускать черные списки IP-адресов на уровне сайта?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Исключите этого пользователя из правил жизненного цикла пользователя?
создано_в	created_at	string	Когда этот пользователь был создан
dav_permission	dav_permission	boolean	Может ли пользователь подключиться к WebDAV?
disabled	disabled	boolean	Отключен ли пользователь? Отключенные пользователи не могут войти в систему и не учитываются в целях выставления счетов. Пользователи могут быть автоматически отключены после периода бездействия с помощью параметра сайта или расписания деактивации после определенной даты.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Вычисляемое свойство, возвращающее значение true, если пользователь отключен или истек или неактивен.
электронная почта	email	string	Адрес электронной почты пользователя
filesystem_layout	filesystem_layout	string	Макет файловой системы
first_login_at	first_login_at	string	Первое время входа пользователя
ftp_permission	ftp_permission	boolean	Может ли пользователь получить доступ с помощью FTP или FTPS?
group_ids	group_ids	string	Разделенный запятыми список идентификаторов групп, в которых этот пользователь является членом
header_text	header_text	string	Текст для отображения пользователю в заголовке пользовательского интерфейса
language	language	string	Предпочитаемый язык
last_login_at	last_login_at	string	Последнее время входа пользователя через любой протокол
last_web_login_at	last_web_login_at	string	Последнее время входа пользователя через веб-сайт
last_ftp_login_at	last_ftp_login_at	string	Последнее время входа пользователя через FTP
last_sftp_login_at	last_sftp_login_at	string	Последнее время входа пользователя через SFTP
last_dav_login_at	last_dav_login_at	string	Последнее время входа пользователя через WebDAV
last_desktop_login_at	last_desktop_login_at	string	Последнее время входа пользователя с помощью классического приложения
last_restapi_login_at	last_restapi_login_at	string	Последнее время входа пользователя через REST API
last_api_use_at	last_api_use_at	string	Последнее время использования API пользователя
last_active_at	last_active_at	string	Последнее время действия пользователя, которое является последним из последних имен входа, последнего использования API, включения или создания
last_protocol_cipher	last_protocol_cipher	string	Самый последний протокол и используемый шифр
lockout_expires	lockout_expires	string	Время в будущем, когда пользователь больше не будет заблокирован, если применимо
имя	name	string	Полное имя пользователя
компания	company	string	Компания пользователя
заметки	notes	string	Все внутренние заметки пользователя
notification_daily_send_time	notification_daily_send_time	integer	Час дня, по которому должны отправляться ежедневные уведомления. Может находиться в диапазоне от 0 до 23
office_integration_enabled	office_integration_enabled	boolean	Включение интеграции с Office для Интернета?
partner_admin	partner_admin	boolean	Является ли этот пользователь администратором партнера?
partner_id	partner_id	integer	Идентификатор партнера, если этот пользователь принадлежит партнеру
partner_name	partner_name	string	Имя партнера, если этот пользователь принадлежит партнеру
password_set_at	password_set_at	string	При последнем настройке пароля пользователя
password_validity_days	password_validity_days	integer	Количество дней, в которых пользователь может использовать тот же пароль.
public_keys_count	public_keys_count	integer	Количество открытых ключей, связанных с этим пользователем
receive_admin_alerts	receive_admin_alerts	boolean	Должен ли пользователь получать оповещения администратора, такие уведомления об истечении срока действия сертификата и превышение срока действия?
require_2fa	require_2fa	string	Обязательный параметр 2FA
require_login_by	require_login_by	string	Требовать, чтобы пользователь входил по указанной дате, в противном случае он будет отключен.
active_2fa	active_2fa	boolean	Активен ли 2fa для пользователя?
require_password_change	require_password_change	boolean	Требуется ли изменение пароля при следующем входе пользователя?
password_expired	password_expired	boolean	Истек срок действия пароля пользователя?
readonly_site_admin	readonly_site_admin	boolean	Разрешено ли пользователю просматривать всю конфигурацию сайта (без выставления счетов) для этого сайта?
restapi_permission	restapi_permission	boolean	Может ли этот пользователь получить доступ к веб-приложению, классическому приложению, пакетам SDK или REST API? (Все эти средства используют API внутри системы, поэтому это один унифицированный набор разрешений.)
self_managed	self_managed	boolean	Управляет ли этот пользователь собственными учетными данными или является ли он общим или ботом?
sftp_permission	sftp_permission	boolean	Может ли пользователь получить доступ с помощью SFTP?
site_admin	site_admin	boolean	Является ли пользователь администратором этого сайта?
site_id	site_id	integer	Идентификатор сайта
skip_welcome_screen	skip_welcome_screen	boolean	Пропустить страницу приветствия в пользовательском интерфейсе?
ssl_required	ssl_required	string	Обязательный параметр SSL
sso_strategy_id	sso_strategy_id	integer	Идентификатор стратегии единого входа (единый вход) для пользователя, если это применимо.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	Подписан ли пользователь на информационный бюллетень?
externally_managed	externally_managed	boolean	Управляется ли этот пользователь SsoStrategy?
tags	tags	string	Разделенный запятыми список тегов для этого пользователя. Теги используются для других функций, таких как UserLifecycleRules, которые могут использовать определенные теги. Теги должны содержать только строчные буквы, цифры и дефисы.
Часовой пояс	time_zone	string	Часовой пояс пользователя
type_of_2fa	type_of_2fa	string	Используемые методы 2FA для программного использования. Будет либо sms, , , totpлибо yubiwebauthnemailнесколько значений отсортированы в алфавитном порядке и присоединены подчеркиванием. Не указывает, имеет ли пользователь несколько из заданного метода.
type_of_2fa_for_display	type_of_2fa_for_display	string	Используемые методы 2FA, отформатированные для отображения в пользовательском интерфейсе. В отличие от type_of_2faэтого значения, это значение будет ясно, если пользователь имеет более 1 одного типа метода.
user_root	user_root	string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
user_home	user_home	string	Домашняя папка для FTP или SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Количество дней, оставшихся до истечения срока действия пароля
password_expire_at	password_expire_at	string	Дата окончания срока действия пароля

Создание ссылки на общий доступ

Идентификатор операции:

PostBundles

Создание ссылки на общий доступ

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Description	description		string	Общедоступное описание
Истекает в	expires_at		date-time	Дата и время окончания срока действия пакета
Максимальное использование	max_uses		integer	Доступ к максимальному количеству пакетов раз
Замечание	note		string	Внутренняя заметка пакета
Пароль	password		string	Пароль для этого пакета.
Paths	paths	True	array of string	Список путей для включения в этот пакет.
Требовать регистрацию	require_registration		boolean	Отображение страницы регистрации, которая записывает имя и адрес электронной почты загрузчика?

Возвращаемое значение

Имя	Путь	Тип	Описание
код	code	string	Код пакета. Этот код формирует конечную часть общедоступного URL-адреса.
color_left	color_left	string	Ссылка на страницу и цвет кнопки
color_link	color_link	string	Цвет ссылок верхней панели
color_text	color_text	string	Ссылка на страницу и цвет кнопки
color_top	color_top	string	Цвет фона верхней панели
color_top_text	color_top_text	string	Цвет текста верхней панели
URL-адрес	url	string	Общедоступный URL-адрес ссылки на общий доступ
описание	description	string	Общедоступное описание
срок_действия_до	expires_at	string	Дата или время окончания срока действия пакета
password_protected	password_protected	boolean	Защищается ли этот пакет паролем?
permissions	permissions	string	Разрешения, которые применяются к папкам в этой ссылке общего ресурса.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Отображение страницы регистрации, которая записывает имя и адрес электронной почты загрузчика?
require_share_recipient	require_share_recipient	boolean	Разрешить доступ только получателям, которые явно получили общую папку через электронную почту, отправленную через пользовательский интерфейс Files.com?
require_logout	require_logout	boolean	Если задано значение true, мы скроем поле "Запомнить меня" на странице регистрации пакета, требуя, чтобы пользователь выходить из системы и входить обратно при каждом посещении страницы.
clickwrap_body	clickwrap_body	string	Юридический текст, который необходимо согласиться перед доступом к пакету.
id	form_field_set.id	integer	Идентификатор набора полей формы
title	form_field_set.title	string	Заголовок для отображения
form_layout	form_field_set.form_layout	array of integer	Макет формы
form_fields	form_field_set.form_fields	array of object	Связанные поля формы
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без указания имени.
skip_email	form_field_set.skip_email	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления электронной почты.
skip_company	form_field_set.skip_company	boolean	Любые связанные параметры InboxRegistrations или BundleRegistrations можно сохранить без предоставления компании
in_use	form_field_set.in_use	boolean	Набор полей формы используется активным почтовым ящиком или пакетом или регистрацией папки "Входящие" или "Регистрация пакета"
skip_name	skip_name	boolean	Можно сохранить пакетыregistrations без предоставления имени?
skip_email	skip_email	boolean	Можно сохранить пакетыregistrations без предоставления электронной почты?
start_access_on_date	start_access_on_date	string	Дата начала доступа к общей папке. Если nil доступ предоставлен сразу после создания.
skip_company	skip_company	boolean	Можно сохранить пакеты, не предоставляя компании?
id	id	integer	Идентификатор пакета
создано_в	created_at	string	Пакет, созданный в дате или времени
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Не создавайте вложенные папки для файлов, отправленных в эту общую папку. Примечание. Существуют тонкие ошибки безопасности, позволяющие анонимным отправкам от нескольких пользователей жить в одной папке. Мы настоятельно не рекомендуем использовать этот вариант, если это не обязательно.
max_uses	max_uses	integer	Доступ к максимальному количеству пакетов раз
Примечание	note	string	Внутренняя заметка пакета
path_template	path_template	string	Шаблон для создания вложенных папок отправки. Можно использовать имя отправителя, адрес электронной почты, ip, компанию, strftime директивы и любые данные пользовательской формы.
path_template_time_zone	path_template_time_zone	string	Часовой пояс, используемый при отрисовке меток времени в шаблонах путей.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Отправьте квитанцию о доставке в отправитель. Примечание. Только для записываемой общей папки
snapshot_id	snapshot_id	integer	Идентификатор моментального снимка, содержащего содержимое этого пакета.
идентификатор пользователя	user_id	integer	Идентификатор пользователя создателя пакета
username	username	string	Имя пользователя создателя пакета
clickwrap_id	clickwrap_id	integer	Идентификатор clickwrap для использования с этим пакетом.
inbox_id	inbox_id	integer	Идентификатор связанной папки "Входящие", если она доступна.
имя	watermark_attachment.name	string	Имя изображения
УРИ	watermark_attachment.uri	string	URI изображения
watermark_value	watermark_value	object	Предварительный просмотр параметров водяного знака, применяемых ко всем элементам пакета. Использует те же ключи, что и Behavior.value
has_inbox	has_inbox	boolean	Имеет ли этот пакет связанную папку "Входящие"?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Следует ли предотвратить отправку папок?
Пути	paths	array of string	Список путей в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
путь к пакетам	bundlepaths	array of object	Список пакетов в этом пакете. По соображениям производительности это не предусмотрено при перечислении пакетов.
items	bundlepaths	object

Создание уведомления по ссылке общего доступа

Идентификатор операции:

PostBundleNotifications

Создание уведомления по ссылке общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пакета	bundle_id	True	integer	Идентификатор пакета для уведомления
Уведомление идентификатора пользователя	notify_user_id		integer	Идентификатор пользователя, который нужно уведомить.

Возвращаемое значение

Имя	Путь	Тип	Описание
bundle_id	bundle_id	integer	Идентификатор пакета для уведомления
id	id	integer	Идентификатор уведомления о пакете
notify_on_registration	notify_on_registration	boolean	Активирует уведомление пакета, когда действие регистрации происходит для него.
notify_on_upload	notify_on_upload	boolean	Активирует уведомление о пакете при выполнении действия отправки.
notify_user_id	notify_user_id	integer	Идентификатор пользователя, который нужно уведомить.

Создание учетной записи пользователя для группы

Идентификатор операции:

PostGroupsGroupIdUsers

Создание учетной записи пользователя для группы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	group_id	True	integer	Идентификатор группы для связывания этого пользователя с.
Метод проверки подлинности	authentication_method		string	Как этот пользователь прошел проверку подлинности?
Компания	company		string	Компания пользователя
Адрес электронной почты	email		string	Электронная почта пользователя.
Идентификаторы группы	group_ids		string	Список идентификаторов группы, с которыми связывается этот пользователь. Разделителя запятыми.
Имя	name		string	Полное имя пользователя
Примечания.	notes		string	Все внутренние заметки пользователя
Пароль	password		string	Пароль пользователя.
Требовать изменение пароля	require_password_change		boolean	Требуется ли изменение пароля при следующем входе пользователя?
Главная страница пользователя	user_home		string	Домашняя папка для FTP/SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Корневой каталог пользователя	user_root		string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
Имя пользователя	username	True	string	Имя пользователя

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор пользователя
username	username	string	Имя пользователя
admin_group_ids	admin_group_ids	array of integer	Список идентификаторов групп, в которых этот пользователь является администратором
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
attachments_permission	attachments_permission	boolean	Если trueпользователь может создавать пакеты (aka Share Links). Используйте вместо этого разрешение пакета.
api_keys_count	api_keys_count	integer	Количество ключей API, связанных с этим пользователем
authenticate_until	authenticate_until	string	Запланированное время или дата, в течение которого пользователь будет деактивирован
authentication_method	authentication_method	string	Как этот пользователь прошел проверку подлинности?
avatar_url	avatar_url	string	URL-адрес, содержащий аватар пользователя
Оплачиваемых	billable	boolean	Это оплачиваемая запись пользователя?
billing_permission	billing_permission	boolean	Разрешить этому пользователю выполнять операции с учетной записью, платежами и счетами?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Разрешить этому пользователю пропускать черные списки IP-адресов на уровне сайта?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Исключите этого пользователя из правил жизненного цикла пользователя?
создано_в	created_at	string	Когда этот пользователь был создан
dav_permission	dav_permission	boolean	Может ли пользователь подключиться к WebDAV?
disabled	disabled	boolean	Отключен ли пользователь? Отключенные пользователи не могут войти в систему и не учитываются в целях выставления счетов. Пользователи могут быть автоматически отключены после периода бездействия с помощью параметра сайта или расписания деактивации после определенной даты.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Вычисляемое свойство, возвращающее значение true, если пользователь отключен или истек или неактивен.
электронная почта	email	string	Адрес электронной почты пользователя
filesystem_layout	filesystem_layout	string	Макет файловой системы
first_login_at	first_login_at	string	Первое время входа пользователя
ftp_permission	ftp_permission	boolean	Может ли пользователь получить доступ с помощью FTP или FTPS?
group_ids	group_ids	string	Разделенный запятыми список идентификаторов групп, в которых этот пользователь является членом
header_text	header_text	string	Текст для отображения пользователю в заголовке пользовательского интерфейса
language	language	string	Предпочитаемый язык
last_login_at	last_login_at	string	Последнее время входа пользователя через любой протокол
last_web_login_at	last_web_login_at	string	Последнее время входа пользователя через веб-сайт
last_ftp_login_at	last_ftp_login_at	string	Последнее время входа пользователя через FTP
last_sftp_login_at	last_sftp_login_at	string	Последнее время входа пользователя через SFTP
last_dav_login_at	last_dav_login_at	string	Последнее время входа пользователя через WebDAV
last_desktop_login_at	last_desktop_login_at	string	Последнее время входа пользователя с помощью классического приложения
last_restapi_login_at	last_restapi_login_at	string	Последнее время входа пользователя через REST API
last_api_use_at	last_api_use_at	string	Последнее время использования API пользователя
last_active_at	last_active_at	string	Последнее время действия пользователя, которое является последним из последних имен входа, последнего использования API, включения или создания
last_protocol_cipher	last_protocol_cipher	string	Самый последний протокол и используемый шифр
lockout_expires	lockout_expires	string	Время в будущем, когда пользователь больше не будет заблокирован, если применимо
имя	name	string	Полное имя пользователя
компания	company	string	Компания пользователя
заметки	notes	string	Все внутренние заметки пользователя
notification_daily_send_time	notification_daily_send_time	integer	Час дня, по которому должны отправляться ежедневные уведомления. Может находиться в диапазоне от 0 до 23
office_integration_enabled	office_integration_enabled	boolean	Включение интеграции с Office для Интернета?
partner_admin	partner_admin	boolean	Является ли этот пользователь администратором партнера?
partner_id	partner_id	integer	Идентификатор партнера, если этот пользователь принадлежит партнеру
partner_name	partner_name	string	Имя партнера, если этот пользователь принадлежит партнеру
password_set_at	password_set_at	string	При последнем настройке пароля пользователя
password_validity_days	password_validity_days	integer	Количество дней, в которых пользователь может использовать тот же пароль.
public_keys_count	public_keys_count	integer	Количество открытых ключей, связанных с этим пользователем
receive_admin_alerts	receive_admin_alerts	boolean	Должен ли пользователь получать оповещения администратора, такие уведомления об истечении срока действия сертификата и превышение срока действия?
require_2fa	require_2fa	string	Обязательный параметр 2FA
require_login_by	require_login_by	string	Требовать, чтобы пользователь входил по указанной дате, в противном случае он будет отключен.
active_2fa	active_2fa	boolean	Активен ли 2fa для пользователя?
require_password_change	require_password_change	boolean	Требуется ли изменение пароля при следующем входе пользователя?
password_expired	password_expired	boolean	Истек срок действия пароля пользователя?
readonly_site_admin	readonly_site_admin	boolean	Разрешено ли пользователю просматривать всю конфигурацию сайта (без выставления счетов) для этого сайта?
restapi_permission	restapi_permission	boolean	Может ли этот пользователь получить доступ к веб-приложению, классическому приложению, пакетам SDK или REST API? (Все эти средства используют API внутри системы, поэтому это один унифицированный набор разрешений.)
self_managed	self_managed	boolean	Управляет ли этот пользователь собственными учетными данными или является ли он общим или ботом?
sftp_permission	sftp_permission	boolean	Может ли пользователь получить доступ с помощью SFTP?
site_admin	site_admin	boolean	Является ли пользователь администратором этого сайта?
site_id	site_id	integer	Идентификатор сайта
skip_welcome_screen	skip_welcome_screen	boolean	Пропустить страницу приветствия в пользовательском интерфейсе?
ssl_required	ssl_required	string	Обязательный параметр SSL
sso_strategy_id	sso_strategy_id	integer	Идентификатор стратегии единого входа (единый вход) для пользователя, если это применимо.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	Подписан ли пользователь на информационный бюллетень?
externally_managed	externally_managed	boolean	Управляется ли этот пользователь SsoStrategy?
tags	tags	string	Разделенный запятыми список тегов для этого пользователя. Теги используются для других функций, таких как UserLifecycleRules, которые могут использовать определенные теги. Теги должны содержать только строчные буквы, цифры и дефисы.
Часовой пояс	time_zone	string	Часовой пояс пользователя
type_of_2fa	type_of_2fa	string	Используемые методы 2FA для программного использования. Будет либо sms, , , totpлибо yubiwebauthnemailнесколько значений отсортированы в алфавитном порядке и присоединены подчеркиванием. Не указывает, имеет ли пользователь несколько из заданного метода.
type_of_2fa_for_display	type_of_2fa_for_display	string	Используемые методы 2FA, отформатированные для отображения в пользовательском интерфейсе. В отличие от type_of_2faэтого значения, это значение будет ясно, если пользователь имеет более 1 одного типа метода.
user_root	user_root	string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
user_home	user_home	string	Домашняя папка для FTP или SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Количество дней, оставшихся до истечения срока действия пароля
password_expire_at	password_expire_at	string	Дата окончания срока действия пароля

Создать группу

Идентификатор операции:

PostGroups

Создать группу

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы администратора	admin_ids		string	Список идентификаторов пользователей администратора группы. При отправке в виде строки следует разделять запятыми.
Имя	name	True	string	Имя группы.
Примечания.	notes		string	Групповые заметки.
Идентификаторы пользователей	user_ids		string	Список идентификаторов пользователей. При отправке в виде строки следует разделять запятыми.

Возвращаемое значение

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор группы
имя	name	string	Имя группы
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
admin_ids	admin_ids	string	Разделенный запятыми список идентификаторов пользователей, которые являются администраторами групп (разделенными запятыми)
заметки	notes	string	Заметки об этой группе
user_ids	user_ids	string	Разделенный запятыми список идентификаторов пользователей, принадлежащих этой группе (разделенных запятыми)
usernames	usernames	string	Разделенный запятыми список имен пользователей, принадлежащих этой группе (разделенных запятыми)
ftp_permission	ftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать FTP для входа. Это переопределит ложное значение ftp_permission на уровне пользователя.
sftp_permission	sftp_permission	boolean	Если значение true, пользователи в этой группе могут использовать SFTP для входа. Это переопределит ложное значение sftp_permission на уровне пользователя.
dav_permission	dav_permission	boolean	Если значение true, пользователи в этой группе могут использовать WebDAV для входа. Это переопределит ложное значение dav_permission на уровне пользователя.
restapi_permission	restapi_permission	boolean	Если значение true, пользователи в этой группе могут использовать REST API для входа. Это переопределит ложное значение restapi_permission на уровне пользователя.
site_id	site_id	integer	Идентификатор сайта

Список пользователей

Идентификатор операции:

GetUsers

Список пользователей

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of object
id	id	integer	Идентификатор пользователя
username	username	string	Имя пользователя
admin_group_ids	admin_group_ids	array of integer	Список идентификаторов групп, в которых этот пользователь является администратором
allowed_ips	allowed_ips	string	Список разрешенных IP-адресов, если это применимо. Разделители Newline
attachments_permission	attachments_permission	boolean	Если trueпользователь может создавать пакеты (aka Share Links). Используйте вместо этого разрешение пакета.
api_keys_count	api_keys_count	integer	Количество ключей API, связанных с этим пользователем
authenticate_until	authenticate_until	string	Запланированное время или дата, в течение которого пользователь будет деактивирован
authentication_method	authentication_method	string	Как этот пользователь прошел проверку подлинности?
avatar_url	avatar_url	string	URL-адрес, содержащий аватар пользователя
Оплачиваемых	billable	boolean	Это оплачиваемая запись пользователя?
billing_permission	billing_permission	boolean	Разрешить этому пользователю выполнять операции с учетной записью, платежами и счетами?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Разрешить этому пользователю пропускать черные списки IP-адресов на уровне сайта?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Исключите этого пользователя из правил жизненного цикла пользователя?
создано_в	created_at	string	Когда этот пользователь был создан
dav_permission	dav_permission	boolean	Может ли пользователь подключиться к WebDAV?
disabled	disabled	boolean	Отключен ли пользователь? Отключенные пользователи не могут войти в систему и не учитываются в целях выставления счетов. Пользователи могут быть автоматически отключены после периода бездействия с помощью параметра сайта или расписания деактивации после определенной даты.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Вычисляемое свойство, возвращающее значение true, если пользователь отключен или истек или неактивен.
электронная почта	email	string	Адрес электронной почты пользователя
filesystem_layout	filesystem_layout	string	Макет файловой системы
first_login_at	first_login_at	string	Первое время входа пользователя
ftp_permission	ftp_permission	boolean	Может ли пользователь получить доступ с помощью FTP или FTPS?
group_ids	group_ids	string	Разделенный запятыми список идентификаторов групп, в которых этот пользователь является членом
header_text	header_text	string	Текст для отображения пользователю в заголовке пользовательского интерфейса
language	language	string	Предпочитаемый язык
last_login_at	last_login_at	string	Последнее время входа пользователя через любой протокол
last_web_login_at	last_web_login_at	string	Последнее время входа пользователя через веб-сайт
last_ftp_login_at	last_ftp_login_at	string	Последнее время входа пользователя через FTP
last_sftp_login_at	last_sftp_login_at	string	Последнее время входа пользователя через SFTP
last_dav_login_at	last_dav_login_at	string	Последнее время входа пользователя через WebDAV
last_desktop_login_at	last_desktop_login_at	string	Последнее время входа пользователя с помощью классического приложения
last_restapi_login_at	last_restapi_login_at	string	Последнее время входа пользователя через REST API
last_api_use_at	last_api_use_at	string	Последнее время использования API пользователя
last_active_at	last_active_at	string	Последнее время действия пользователя, которое является последним из последних имен входа, последнего использования API, включения или создания
last_protocol_cipher	last_protocol_cipher	string	Самый последний протокол и используемый шифр
lockout_expires	lockout_expires	string	Время в будущем, когда пользователь больше не будет заблокирован, если применимо
имя	name	string	Полное имя пользователя
компания	company	string	Компания пользователя
заметки	notes	string	Все внутренние заметки пользователя
notification_daily_send_time	notification_daily_send_time	integer	Час дня, по которому должны отправляться ежедневные уведомления. Может находиться в диапазоне от 0 до 23
office_integration_enabled	office_integration_enabled	boolean	Включение интеграции с Office для Интернета?
partner_admin	partner_admin	boolean	Является ли этот пользователь администратором партнера?
partner_id	partner_id	integer	Идентификатор партнера, если этот пользователь принадлежит партнеру
partner_name	partner_name	string	Имя партнера, если этот пользователь принадлежит партнеру
password_set_at	password_set_at	string	При последнем настройке пароля пользователя
password_validity_days	password_validity_days	integer	Количество дней, в которых пользователь может использовать тот же пароль.
public_keys_count	public_keys_count	integer	Количество открытых ключей, связанных с этим пользователем
receive_admin_alerts	receive_admin_alerts	boolean	Должен ли пользователь получать оповещения администратора, такие уведомления об истечении срока действия сертификата и превышение срока действия?
require_2fa	require_2fa	string	Обязательный параметр 2FA
require_login_by	require_login_by	string	Требовать, чтобы пользователь входил по указанной дате, в противном случае он будет отключен.
active_2fa	active_2fa	boolean	Активен ли 2fa для пользователя?
require_password_change	require_password_change	boolean	Требуется ли изменение пароля при следующем входе пользователя?
password_expired	password_expired	boolean	Истек срок действия пароля пользователя?
readonly_site_admin	readonly_site_admin	boolean	Разрешено ли пользователю просматривать всю конфигурацию сайта (без выставления счетов) для этого сайта?
restapi_permission	restapi_permission	boolean	Может ли этот пользователь получить доступ к веб-приложению, классическому приложению, пакетам SDK или REST API? (Все эти средства используют API внутри системы, поэтому это один унифицированный набор разрешений.)
self_managed	self_managed	boolean	Управляет ли этот пользователь собственными учетными данными или является ли он общим или ботом?
sftp_permission	sftp_permission	boolean	Может ли пользователь получить доступ с помощью SFTP?
site_admin	site_admin	boolean	Является ли пользователь администратором этого сайта?
site_id	site_id	integer	Идентификатор сайта
skip_welcome_screen	skip_welcome_screen	boolean	Пропустить страницу приветствия в пользовательском интерфейсе?
ssl_required	ssl_required	string	Обязательный параметр SSL
sso_strategy_id	sso_strategy_id	integer	Идентификатор стратегии единого входа (единый вход) для пользователя, если это применимо.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	Подписан ли пользователь на информационный бюллетень?
externally_managed	externally_managed	boolean	Управляется ли этот пользователь SsoStrategy?
tags	tags	string	Разделенный запятыми список тегов для этого пользователя. Теги используются для других функций, таких как UserLifecycleRules, которые могут использовать определенные теги. Теги должны содержать только строчные буквы, цифры и дефисы.
Часовой пояс	time_zone	string	Часовой пояс пользователя
type_of_2fa	type_of_2fa	string	Используемые методы 2FA для программного использования. Будет либо sms, , , totpлибо yubiwebauthnemailнесколько значений отсортированы в алфавитном порядке и присоединены подчеркиванием. Не указывает, имеет ли пользователь несколько из заданного метода.
type_of_2fa_for_display	type_of_2fa_for_display	string	Используемые методы 2FA, отформатированные для отображения в пользовательском интерфейсе. В отличие от type_of_2faэтого значения, это значение будет ясно, если пользователь имеет более 1 одного типа метода.
user_root	user_root	string	Корневая папка для FTP (и при необходимости SFTP, если задан соответствующий параметр на уровне сайта). Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
user_home	user_home	string	Домашняя папка для FTP или SFTP. Обратите внимание, что это не используется для API, рабочего стола или веб-интерфейса.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Количество дней, оставшихся до истечения срока действия пароля
password_expire_at	password_expire_at	string	Дата окончания срока действия пароля

Удаление пользователя

Идентификатор операции:

DeleteUsersId

Удаление пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	ИД пользователя

Удаление уведомления по ссылке общего доступа

Идентификатор операции:

DeleteBundleNotificationsId

Удаление уведомления по ссылке общего доступа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор уведомления пакета.

Удаление файла или папки

Идентификатор операции:

DeleteFilesPath

Удаление файла или папки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path	True	string	Путь к работе.

Удалить группу

Идентификатор операции:

DeleteGroupsId

Удалить группу

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор группы.

Удалить ссылку на общий ресурс

Идентификатор операции:

DeleteBundlesId

Удалить ссылку на общий ресурс

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор пакета.

Определения

бинарный

Это базовый тип данных binary.