Files.com (versão prévia)

O conector Files.com fornece uma integração direta e de alto desempenho ao Files.com para fluxos de trabalho automatizados e integrações na plataforma de automação da Microsoft.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte Files.com
URL	https://www.files.com/contact
Email	support@files.com

Metadados do conector
Publicador	Files.com
Site	https://www.files.com/
Política de privacidade	https://www.files.com/legal/privacy
Categorias	Conteúdo e arquivos;Operações de TI

Conector do Files.com Power Automate

Visão geral

O conector Files.com fornece uma integração direta e de alto desempenho ao Files.com do Microsoft Power Automate e dos Aplicativos Lógicos do Azure. Files.com é a plataforma nativa de nuvem, MFT, SFTP e compartilhamento seguro de arquivos que substitui servidores herdados frágeis por uma malha sempre ativa e segura. Automatize os fluxos de arquivos críticos em qualquer nuvem, protocolo ou parceiro, ao mesmo tempo em que dá suporte à colaboração humana e elimina o trabalho manual.

Observação: esse conector fornece apenas ações e ainda não inclui gatilhos.

⸻

Pré-requisitos

Antes de usar esse conector, verifique se você tem: 1. Uma conta de Files.com válida com uma chave de API. 2. Acesso ao Microsoft Power Automate.

⸻

Authentication

Esse conector usa a Autenticação de Chave de API. Sua chave de API pode ser gerada em sua conta Files.com em:

Configurações → chaves de API → criar chave de API.

Ao configurar o conector, insira o Files.com Host e a Chave de API nos campos de autenticação.

Exemplo:

Host: sua chave de API de empresa: abc123456789...

Todas as solicitações são enviadas para:

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

⸻

Exemplo de Casos de Uso 1. Gerenciar usuários e grupos Criar, atualizar ou desativar usuários, atribuir funções e gerenciar associações de grupo diretamente por meio de ações do Power Automate. 2. Automatizar fluxos de trabalho de link de compartilhamento (pacote) Gerar links de compartilhamento para entrega de arquivos, adicionar destinatários, configurar notificações ou revogar o acesso automaticamente. 3. Sincronizar pastas de lista de metadados de arquivo, recuperar metadados de arquivo e aplicar lógica de automação, como alterações de permissão ou marcação. 4. Criar fluxos de trabalho de provisionamento de usuário integra sistemas de gerenciamento de RH ou identidade com Files.com para criar automaticamente usuários ou atualizar o acesso quando ocorrerem alterações. 5. Disparar a distribuição de documentos Combine Files.com ações com o OneDrive ou o SharePoint para distribuir ou arquivar documentos com segurança.

⸻

Support

Para obter assistência técnica ou perguntas sobre a instalação do conector, entre em contato com Files.com Suporte em https://www.files.com/contact

Para problemas específicos do Power Automate, consulte a Documentação do Conector Personalizado da Microsoft.

⸻

Aviso legal

Esse conector é fornecido pelo Files.com. Ao usar esse conector, você concorda com os Termos de Serviço e a Política de Privacidade do Files.com.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
chave_de_api	secureString	O api_key desta api	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar grupo	Atualizar grupo
Atualizar Link de Compartilhamento	Atualizar Link de Compartilhamento
Atualizar notificação do Link de Compartilhamento	Atualizar notificação do Link de Compartilhamento
Atualizar Usuário	Atualizar Usuário
Atualizar Usuário	Atualizar Usuário
Baixar Arquivo	Baixar Arquivo
Carregar Arquivo	Carregar Arquivo
Copiar arquivo ou pasta	Copiar arquivo ou pasta
Criar destinatário do link de compartilhamento	Criar destinatário do link de compartilhamento
Criar Grupo	Criar Grupo
Criar Link de Compartilhamento	Criar Link de Compartilhamento
Criar notificação do Link de Compartilhamento	Criar notificação do Link de Compartilhamento
Criar pasta	Criar pasta
Criar uma nova conta de usuário para o grupo	Criar uma nova conta de usuário para o grupo
Criar Usuário	Criar Usuário
Excluir arquivo ou pasta	Excluir arquivo ou pasta
Excluir grupo	Excluir grupo
Excluir Link de Compartilhamento	Excluir Link de Compartilhamento
Excluir Notificação de Link de Compartilhamento	Excluir Notificação de Link de Compartilhamento
Excluir usuário	Excluir usuário
Listar destinatários de link de compartilhamento	Listar destinatários de link de compartilhamento
Listar downloads de link de compartilhamento	Listar downloads de link de compartilhamento
Listar grupos	Listar grupos
Listar Links de Compartilhamento	Listar Links de Compartilhamento
Listar notificações de link de compartilhamento	Listar notificações de link de compartilhamento
Listar pastas por caminho	Listar pastas por caminho
Listar registros de link de compartilhamento	Listar registros de link de compartilhamento
Listar usuários	Listar usuários
Localizar arquivo ou pasta por caminho	Localizar arquivo ou pasta por caminho
Mostrar Grupo	Mostrar Grupo
Mostrar Link de Compartilhamento	Mostrar Link de Compartilhamento
Mostrar Notificação de Link de Compartilhamento	Mostrar Notificação de Link de Compartilhamento
Mostrar Usuário	Mostrar Usuário
Mover arquivo ou pasta	Mover arquivo ou pasta

Atualizar grupo

ID da operação:: PatchGroupsId

Atualizar grupo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID do grupo.
IDs de administrador	admin_ids		string	Uma lista de IDs de usuário do administrador do grupo. Se enviado como uma cadeia de caracteres, deve ser delimitado por vírgula.
Nome	name		string	Nome do grupo.
Anotações	notes		string	Notas de grupo.
IDs de usuário	user_ids		string	Uma lista de IDs de usuário. Se enviado como uma cadeia de caracteres, deve ser delimitado por vírgula.

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do grupo
nome	name	string	Nome do grupo
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
admin_ids	admin_ids	string	Lista delimitada por vírgulas de IDs de usuário que são administradores de grupo (separadas por vírgulas)
notas	notes	string	Anotações sobre esse grupo
user_ids	user_ids	string	Lista delimitada por vírgulas de IDs de usuário que pertencem a esse grupo (separadas por vírgulas)
usernames	usernames	string	Lista delimitada por vírgulas de nomes de usuário que pertencem a esse grupo (separados por vírgulas)
ftp_permission	ftp_permission	boolean	Se for true, os usuários desse grupo poderão usar FTP para fazer logon. Isso substituirá um valor falso no nível do `ftp_permission` usuário.
sftp_permission	sftp_permission	boolean	Se for true, os usuários desse grupo poderão usar o SFTP para fazer logon. Isso substituirá um valor falso no nível do `sftp_permission` usuário.
dav_permission	dav_permission	boolean	Se for true, os usuários desse grupo poderão usar o WebDAV para fazer logon. Isso substituirá um valor falso no nível do `dav_permission` usuário.
restapi_permission	restapi_permission	boolean	Se for true, os usuários desse grupo poderão usar a API REST para fazer logon. Isso substituirá um valor falso no nível do `restapi_permission` usuário.
site_id	site_id	integer	ID do Site

Atualizar Link de Compartilhamento

ID da operação:: PatchBundlesId

Atualizar Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID do pacote.
Expira em	expires_at		date-time	Data/hora de expiração do pacote

Retornos

Nome	Caminho	Tipo	Description
codificar	code	string	Código do pacote. Esse código forma a parte final da URL Pública.
color_left	color_left	string	Link da página e cor do botão
color_link	color_link	string	Cor do link da barra superior
color_text	color_text	string	Link da página e cor do botão
color_top	color_top	string	Cor da tela de fundo da barra superior
color_top_text	color_top_text	string	Cor do texto da barra superior
url	url	string	URL pública do Link de Compartilhamento
descrição	description	string	Descrição pública
expira_em	expires_at	string	Data ou hora de expiração do pacote
password_protected	password_protected	boolean	Esse pacote é protegido por senha?
permissões	permissions	string	Permissões que se aplicam a Pastas neste Link de Compartilhamento.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Mostrar uma página de registro que captura o nome e o endereço de email do downloader?
require_share_recipient	require_share_recipient	boolean	Permitir apenas o acesso aos destinatários que receberam explicitamente o compartilhamento por meio de um email enviado pela interface do usuário do Files.com?
require_logout	require_logout	boolean	Se for true, ocultaremos a caixa 'Lembrar-me' na página de registro do Pacote, exigindo que o usuário faça logoff e faça logoff sempre que visitar a página.
clickwrap_body	clickwrap_body	string	Texto legal que deve ser acordado antes de acessar o Pacote.
id	form_field_set.id	integer	ID do conjunto de campos de formulário
title	form_field_set.title	string	Título a ser exibido
form_layout	form_field_set.form_layout	array of integer	Layout do formulário
form_fields	form_field_set.form_fields	array of object	Campos de formulário associados
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer o nome
skip_email	form_field_set.skip_email	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer email
skip_company	form_field_set.skip_company	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer a empresa
in_use	form_field_set.in_use	boolean	O Conjunto de Campos de Formulário está em uso por uma caixa de entrada ativa ou pacote ou registro de caixa de entrada ou registro de pacote
skip_name	skip_name	boolean	BundleRegistrations pode ser salvo sem fornecer o nome?
skip_email	skip_email	boolean	BundleRegistrations pode ser salvo sem fornecer email?
start_access_on_date	start_access_on_date	string	Data em que o compartilhamento começará a ser acessível. Se `nil` o acesso for concedido logo após a criação.
skip_company	skip_company	boolean	Os BundleRegistrations podem ser salvos sem fornecer a empresa?
id	id	integer	ID do pacote
criado_em	created_at	string	Pacote criado em data ou hora
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Não crie subpastas para arquivos carregados neste compartilhamento. Observação: há armadilhas de segurança sutis com a permissão de uploads anônimos de vários usuários para viver na mesma pasta. Desencorajamos fortemente o uso dessa opção, a menos que seja absolutamente necessário.
max_uses	max_uses	integer	Número máximo de vezes que o pacote pode ser acessado
nota	note	string	Nota interna do pacote
path_template	path_template	string	Modelo para criar subpastas de envio. Pode usar o nome do carregador, o endereço de email, o ip, a empresa, `strftime` as diretivas e quaisquer dados de formulário personalizados.
path_template_time_zone	path_template_time_zone	string	Fuso horário a ser usado ao renderizar carimbos de data/hora em modelos de caminho.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Envie o recibo de entrega para o carregador. Observação: somente para compartilhamento gravável
snapshot_id	snapshot_id	integer	ID do instantâneo que contém o conteúdo desse pacote.
id_do_usuário	user_id	integer	ID do usuário do criador do pacote
nome de usuário	username	string	Nome de usuário do criador do pacote
clickwrap_id	clickwrap_id	integer	ID do clickwrap a ser usado com esse pacote.
inbox_id	inbox_id	integer	ID da caixa de entrada associada, se disponível.
nome	watermark_attachment.name	string	Nome da imagem
uri	watermark_attachment.uri	string	URI da imagem
watermark_value	watermark_value	object	Visualizar as configurações de marca d'água aplicadas a todos os itens de pacote. Usa as mesmas chaves que Behavior.value
has_inbox	has_inbox	boolean	Esse pacote tem uma caixa de entrada associada?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Os uploads de pasta devem ser evitados?
Caminhos	paths	array of string	Uma lista de caminhos neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
bundlepaths	bundlepaths	array of object	Uma lista de bundlepaths neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
items	bundlepaths	object

Atualizar notificação do Link de Compartilhamento

ID da operação:: PatchBundleNotificationsId

Atualizar notificação do Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID de notificação do pacote.
Notificar sobre o registro	notify_on_registration		boolean	Dispara a notificação de pacote quando ocorre uma ação de registro para ela.
Notificar no upload	notify_on_upload		boolean	Dispara a notificação de pacote quando uma ação de upload ocorre para ela.

Retornos

Nome	Caminho	Tipo	Description
bundle_id	bundle_id	integer	ID do pacote para notificar sobre
id	id	integer	ID de notificação do pacote
notify_on_registration	notify_on_registration	boolean	Dispara a notificação de pacote quando ocorre uma ação de registro para ela.
notify_on_upload	notify_on_upload	boolean	Dispara a notificação de pacote quando uma ação de upload ocorre para ela.
notify_user_id	notify_user_id	integer	A ID do usuário a ser notificada.

Atualizar Usuário

ID da operação:: PatchUser

Atualizar Usuário

Parâmetros

Nome	Chave	Tipo	Description
Método de autenticação	authentication_method	string	Como esse usuário é autenticado?
Empresa	company	string	Empresa do usuário
Email	email	string	Email do usuário.
IDs de grupo	group_ids	string	Uma lista de IDs de grupo à qual associar esse usuário. Vírgula delimitada.
Nome	name	string	Nome completo do usuário
Anotações	notes	string	Quaisquer anotações internas sobre o usuário
Senha	password	string	Senha do usuário.
Exigir alteração de senha	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
Página Inicial do Usuário	user_home	string	Pasta inicial para FTP/SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Raiz do Usuário	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Nome de usuário	username	string	Nome de usuário do usuário

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do Usuário
nome de usuário	username	string	Nome de usuário do usuário
admin_group_ids	admin_group_ids	array of integer	Lista de IDs de grupo das quais esse usuário é um administrador
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
attachments_permission	attachments_permission	boolean	Se `true`, o usuário pode criar pacotes (também conhecidos como Links de Compartilhamento). Em vez disso, use a permissão do pacote.
api_keys_count	api_keys_count	integer	Número de chaves de API associadas a esse usuário
authenticate_until	authenticate_until	string	Data ou hora agendadas em que o usuário será desativado
authentication_method	authentication_method	string	Como esse usuário é autenticado?
avatar_url	avatar_url	string	URL que contém o avatar do usuário
Faturável	billable	boolean	Este é um registro de usuário faturável?
billing_permission	billing_permission	boolean	Permitir que esse usuário execute operações na conta, pagamentos e faturas?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Permitir que esse usuário ignore listas negras de IP em todo o site?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Isentar esse usuário das regras de ciclo de vida do usuário?
criado_em	created_at	string	Quando esse usuário foi criado
dav_permission	dav_permission	boolean	O usuário pode se conectar ao WebDAV?
desabilitado	disabled	boolean	O usuário está desabilitado? Os usuários desabilitados não podem fazer logon e não contam para fins de cobrança. Os usuários podem ser desabilitados automaticamente após um período de inatividade por meio de uma configuração do Site ou agendamento a ser desativado após uma data específica.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Propriedade computada que retorna true se o usuário desabilitado ou expirado ou inativo.
email	email	string	Endereço de email do usuário
filesystem_layout	filesystem_layout	string	Layout do sistema de arquivos
first_login_at	first_login_at	string	Primeira vez de logon do usuário
ftp_permission	ftp_permission	boolean	O usuário pode acessar com FTP ou FTPS?
group_ids	group_ids	string	Lista separada por vírgulas de IDs de grupo das quais esse usuário é membro
header_text	header_text	string	Texto a ser exibido para o usuário no cabeçalho da interface do usuário
linguagem	language	string	Idioma preferencial
last_login_at	last_login_at	string	Hora de logon mais recente do usuário por meio de qualquer protocolo
last_web_login_at	last_web_login_at	string	Hora de logon mais recente do usuário via Web
last_ftp_login_at	last_ftp_login_at	string	Hora de logon mais recente do usuário via FTP
last_sftp_login_at	last_sftp_login_at	string	Tempo de logon mais recente do usuário via SFTP
last_dav_login_at	last_dav_login_at	string	Hora de logon mais recente do usuário via WebDAV
last_desktop_login_at	last_desktop_login_at	string	Hora de logon mais recente do usuário por meio do aplicativo desktop
last_restapi_login_at	last_restapi_login_at	string	Tempo de logon mais recente do usuário por meio da API Rest
last_api_use_at	last_api_use_at	string	Tempo de uso mais recente da API do usuário
última_atividade_em	last_active_at	string	O tempo de atividade mais recente do usuário, que é o mais recente do logon mais recente, o uso, a habilitação ou a criação da API mais recente
last_protocol_cipher	last_protocol_cipher	string	O protocolo e a criptografia mais recentes usados
lockout_expires	lockout_expires	string	Hora no futuro em que o usuário não será mais bloqueado se aplicável
nome	name	string	Nome completo do usuário
empresa	company	string	Empresa do usuário
notas	notes	string	Quaisquer anotações internas sobre o usuário
notification_daily_send_time	notification_daily_send_time	integer	Hora do dia em que as notificações diárias devem ser enviadas. Pode estar no intervalo de 0 a 23
office_integration_enabled	office_integration_enabled	boolean	Habilitar a integração com o Office para a Web?
partner_admin	partner_admin	boolean	Esse usuário é um administrador de parceiros?
partner_id	partner_id	integer	ID do parceiro se este usuário pertencer a um Parceiro
partner_name	partner_name	string	Nome do Parceiro se este usuário pertencer a um Parceiro
password_set_at	password_set_at	string	Última vez que a senha do usuário foi definida
password_validity_days	password_validity_days	integer	Número de dias para permitir que o usuário use a mesma senha
public_keys_count	public_keys_count	integer	Número de chaves públicas associadas a esse usuário
receive_admin_alerts	receive_admin_alerts	boolean	O usuário deve receber alertas de administrador, como notificações de expiração de certificado e excessos?
require_2fa	require_2fa	string	Configuração necessária para 2FA
require_login_by	require_login_by	string	Exija que o usuário faça logon por data especificada, caso contrário, ele será desabilitado.
active_2fa	active_2fa	boolean	O 2fa está ativo para o usuário?
require_password_change	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
password_expired	password_expired	boolean	A senha do usuário expirou?
readonly_site_admin	readonly_site_admin	boolean	O usuário tem permissão para exibir todas as configurações de site (sem cobrança) deste site?
restapi_permission	restapi_permission	boolean	Esse usuário pode acessar o aplicativo Web, o aplicativo da área de trabalho, os SDKs ou a API REST? (Todas essas ferramentas usam a API internamente, portanto, esse é um conjunto de permissões unificado.)
self_managed	self_managed	boolean	Esse usuário gerencia suas próprias credenciais ou é um usuário compartilhado ou bot?
sftp_permission	sftp_permission	boolean	O usuário pode acessar com o SFTP?
site_admin	site_admin	boolean	O usuário é um administrador para este site?
site_id	site_id	integer	ID do Site
skip_welcome_screen	skip_welcome_screen	boolean	Ignorar a página de boas-vindas na interface do usuário?
ssl_required	ssl_required	string	Configuração necessária para SSL
sso_strategy_id	sso_strategy_id	integer	ID de estratégia de SSO (Logon Único) para o usuário, se aplicável.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	O usuário está inscrito no boletim informativo?
externally_managed	externally_managed	boolean	Esse usuário é gerenciado por um SsoStrategy?
tags	tags	string	Lista separada por vírgulas de Marcas para este usuário. As marcas são usadas para outros recursos, como UserLifecycleRules, que podem direcionar marcas específicas. As marcas devem conter apenas letras minúsculas, números e hifens.
fuso horário	time_zone	string	Fuso horário do usuário
type_of_2fa	type_of_2fa	string	Tipos de métodos 2FA em uso para uso programático. `sms`Serão, , `totp`, `webauthn`, `yubi`, `email`ou vários valores classificados em ordem alfabética e unidos por um sublinhado. Não especifica se o usuário tem mais de um de um determinado método.
type_of_2fa_for_display	type_of_2fa_for_display	string	Tipos de métodos 2FA em uso, formatados para exibição na interface do usuário. Diferentemente `type_of_2fa`disso, esse valor deixará claro quando um usuário tiver mais de 1 do mesmo tipo de método.
user_root	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
user_home	user_home	string	Pasta inicial para FTP ou SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Número de dias restantes até que a senha expire
password_expire_at	password_expire_at	string	Datetime de expiração de senha

Atualizar Usuário

ID da operação:: PatchUsersId

Atualizar Usuário

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID de usuário.
Método de autenticação	authentication_method		string	Como esse usuário é autenticado?
Empresa	company		string	Empresa do usuário
Email	email		string	Email do usuário.
IDs de grupo	group_ids		string	Uma lista de IDs de grupo à qual associar esse usuário. Vírgula delimitada.
Nome	name		string	Nome completo do usuário
Anotações	notes		string	Quaisquer anotações internas sobre o usuário
Senha	password		string	Senha do usuário.
Exigir alteração de senha	require_password_change		boolean	Uma alteração de senha é necessária no logon do próximo usuário?
Página Inicial do Usuário	user_home		string	Pasta inicial para FTP/SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Raiz do Usuário	user_root		string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Nome de usuário	username		string	Nome de usuário do usuário

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do Usuário
nome de usuário	username	string	Nome de usuário do usuário
admin_group_ids	admin_group_ids	array of integer	Lista de IDs de grupo das quais esse usuário é um administrador
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
attachments_permission	attachments_permission	boolean	Se `true`, o usuário pode criar pacotes (também conhecidos como Links de Compartilhamento). Em vez disso, use a permissão do pacote.
api_keys_count	api_keys_count	integer	Número de chaves de API associadas a esse usuário
authenticate_until	authenticate_until	string	Data ou hora agendadas em que o usuário será desativado
authentication_method	authentication_method	string	Como esse usuário é autenticado?
avatar_url	avatar_url	string	URL que contém o avatar do usuário
Faturável	billable	boolean	Este é um registro de usuário faturável?
billing_permission	billing_permission	boolean	Permitir que esse usuário execute operações na conta, pagamentos e faturas?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Permitir que esse usuário ignore listas negras de IP em todo o site?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Isentar esse usuário das regras de ciclo de vida do usuário?
criado_em	created_at	string	Quando esse usuário foi criado
dav_permission	dav_permission	boolean	O usuário pode se conectar ao WebDAV?
desabilitado	disabled	boolean	O usuário está desabilitado? Os usuários desabilitados não podem fazer logon e não contam para fins de cobrança. Os usuários podem ser desabilitados automaticamente após um período de inatividade por meio de uma configuração do Site ou agendamento a ser desativado após uma data específica.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Propriedade computada que retorna true se o usuário desabilitado ou expirado ou inativo.
email	email	string	Endereço de email do usuário
filesystem_layout	filesystem_layout	string	Layout do sistema de arquivos
first_login_at	first_login_at	string	Primeira vez de logon do usuário
ftp_permission	ftp_permission	boolean	O usuário pode acessar com FTP ou FTPS?
group_ids	group_ids	string	Lista separada por vírgulas de IDs de grupo das quais esse usuário é membro
header_text	header_text	string	Texto a ser exibido para o usuário no cabeçalho da interface do usuário
linguagem	language	string	Idioma preferencial
last_login_at	last_login_at	string	Hora de logon mais recente do usuário por meio de qualquer protocolo
last_web_login_at	last_web_login_at	string	Hora de logon mais recente do usuário via Web
last_ftp_login_at	last_ftp_login_at	string	Hora de logon mais recente do usuário via FTP
last_sftp_login_at	last_sftp_login_at	string	Tempo de logon mais recente do usuário via SFTP
last_dav_login_at	last_dav_login_at	string	Hora de logon mais recente do usuário via WebDAV
last_desktop_login_at	last_desktop_login_at	string	Hora de logon mais recente do usuário por meio do aplicativo desktop
last_restapi_login_at	last_restapi_login_at	string	Tempo de logon mais recente do usuário por meio da API Rest
last_api_use_at	last_api_use_at	string	Tempo de uso mais recente da API do usuário
última_atividade_em	last_active_at	string	O tempo de atividade mais recente do usuário, que é o mais recente do logon mais recente, o uso, a habilitação ou a criação da API mais recente
last_protocol_cipher	last_protocol_cipher	string	O protocolo e a criptografia mais recentes usados
lockout_expires	lockout_expires	string	Hora no futuro em que o usuário não será mais bloqueado se aplicável
nome	name	string	Nome completo do usuário
empresa	company	string	Empresa do usuário
notas	notes	string	Quaisquer anotações internas sobre o usuário
notification_daily_send_time	notification_daily_send_time	integer	Hora do dia em que as notificações diárias devem ser enviadas. Pode estar no intervalo de 0 a 23
office_integration_enabled	office_integration_enabled	boolean	Habilitar a integração com o Office para a Web?
partner_admin	partner_admin	boolean	Esse usuário é um administrador de parceiros?
partner_id	partner_id	integer	ID do parceiro se este usuário pertencer a um Parceiro
partner_name	partner_name	string	Nome do Parceiro se este usuário pertencer a um Parceiro
password_set_at	password_set_at	string	Última vez que a senha do usuário foi definida
password_validity_days	password_validity_days	integer	Número de dias para permitir que o usuário use a mesma senha
public_keys_count	public_keys_count	integer	Número de chaves públicas associadas a esse usuário
receive_admin_alerts	receive_admin_alerts	boolean	O usuário deve receber alertas de administrador, como notificações de expiração de certificado e excessos?
require_2fa	require_2fa	string	Configuração necessária para 2FA
require_login_by	require_login_by	string	Exija que o usuário faça logon por data especificada, caso contrário, ele será desabilitado.
active_2fa	active_2fa	boolean	O 2fa está ativo para o usuário?
require_password_change	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
password_expired	password_expired	boolean	A senha do usuário expirou?
readonly_site_admin	readonly_site_admin	boolean	O usuário tem permissão para exibir todas as configurações de site (sem cobrança) deste site?
restapi_permission	restapi_permission	boolean	Esse usuário pode acessar o aplicativo Web, o aplicativo da área de trabalho, os SDKs ou a API REST? (Todas essas ferramentas usam a API internamente, portanto, esse é um conjunto de permissões unificado.)
self_managed	self_managed	boolean	Esse usuário gerencia suas próprias credenciais ou é um usuário compartilhado ou bot?
sftp_permission	sftp_permission	boolean	O usuário pode acessar com o SFTP?
site_admin	site_admin	boolean	O usuário é um administrador para este site?
site_id	site_id	integer	ID do Site
skip_welcome_screen	skip_welcome_screen	boolean	Ignorar a página de boas-vindas na interface do usuário?
ssl_required	ssl_required	string	Configuração necessária para SSL
sso_strategy_id	sso_strategy_id	integer	ID de estratégia de SSO (Logon Único) para o usuário, se aplicável.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	O usuário está inscrito no boletim informativo?
externally_managed	externally_managed	boolean	Esse usuário é gerenciado por um SsoStrategy?
tags	tags	string	Lista separada por vírgulas de Marcas para este usuário. As marcas são usadas para outros recursos, como UserLifecycleRules, que podem direcionar marcas específicas. As marcas devem conter apenas letras minúsculas, números e hifens.
fuso horário	time_zone	string	Fuso horário do usuário
type_of_2fa	type_of_2fa	string	Tipos de métodos 2FA em uso para uso programático. `sms`Serão, , `totp`, `webauthn`, `yubi`, `email`ou vários valores classificados em ordem alfabética e unidos por um sublinhado. Não especifica se o usuário tem mais de um de um determinado método.
type_of_2fa_for_display	type_of_2fa_for_display	string	Tipos de métodos 2FA em uso, formatados para exibição na interface do usuário. Diferentemente `type_of_2fa`disso, esse valor deixará claro quando um usuário tiver mais de 1 do mesmo tipo de método.
user_root	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
user_home	user_home	string	Pasta inicial para FTP ou SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Número de dias restantes até que a senha expire
password_expire_at	password_expire_at	string	Datetime de expiração de senha

Baixar Arquivo

ID da operação:: DownloadFile

Baixar Arquivo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.

Retornos

Conteúdos do arquivo: binary

Carregar Arquivo

ID da operação:: UploadFile

Carregar Arquivo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.
Conteúdos do arquivo	body	True	binary	Conteúdo do arquivo a ser carregado. Envie os bytes exatos que você deseja armazenar em Files.com.

Copiar arquivo ou pasta

ID da operação:: FileActionCopy

Copiar arquivo ou pasta

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.
Destino	destination	True	string	Copiar caminho de destino.

Retornos

Nome	Caminho	Tipo	Description
status	status	string	Status da operação de arquivo.
file_migration_id	file_migration_id	integer	Se o status estiver pendente, essa será a ID da Migração de Arquivos para verificar se há atualizações de status.

Criar destinatário do link de compartilhamento

ID da operação:: PostBundleRecipients

Criar destinatário do link de compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pacote	bundle_id	True	integer	Agrupar para compartilhar.
Empresa	company		string	Empresa de destinatário.
Nome	name		string	Nome do destinatário.
Observação	note		string	Observação para incluir no email.
Recipient	recipient	True	string	Endereços de email com os quais compartilhar esse pacote.

Retornos

Nome	Caminho	Tipo	Description
empresa	company	string	A empresa do destinatário.
nome	name	string	O nome do destinatário.
nota	note	string	Uma nota enviada ao destinatário com o pacote.
destinatário	recipient	string	O endereço de email do destinatário.
sent_at	sent_at	string	Quando o Pacote foi compartilhado com esse destinatário.

Criar Grupo

ID da operação:: PostGroups

Criar Grupo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
IDs de administrador	admin_ids		string	Uma lista de IDs de usuário do administrador do grupo. Se enviado como uma cadeia de caracteres, deve ser delimitado por vírgula.
Nome	name	True	string	Nome do grupo.
Anotações	notes		string	Notas de grupo.
IDs de usuário	user_ids		string	Uma lista de IDs de usuário. Se enviado como uma cadeia de caracteres, deve ser delimitado por vírgula.

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do grupo
nome	name	string	Nome do grupo
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
admin_ids	admin_ids	string	Lista delimitada por vírgulas de IDs de usuário que são administradores de grupo (separadas por vírgulas)
notas	notes	string	Anotações sobre esse grupo
user_ids	user_ids	string	Lista delimitada por vírgulas de IDs de usuário que pertencem a esse grupo (separadas por vírgulas)
usernames	usernames	string	Lista delimitada por vírgulas de nomes de usuário que pertencem a esse grupo (separados por vírgulas)
ftp_permission	ftp_permission	boolean	Se for true, os usuários desse grupo poderão usar FTP para fazer logon. Isso substituirá um valor falso no nível do `ftp_permission` usuário.
sftp_permission	sftp_permission	boolean	Se for true, os usuários desse grupo poderão usar o SFTP para fazer logon. Isso substituirá um valor falso no nível do `sftp_permission` usuário.
dav_permission	dav_permission	boolean	Se for true, os usuários desse grupo poderão usar o WebDAV para fazer logon. Isso substituirá um valor falso no nível do `dav_permission` usuário.
restapi_permission	restapi_permission	boolean	Se for true, os usuários desse grupo poderão usar a API REST para fazer logon. Isso substituirá um valor falso no nível do `restapi_permission` usuário.
site_id	site_id	integer	ID do Site

Criar Link de Compartilhamento

ID da operação:: PostBundles

Criar Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Description	description		string	Descrição pública
Expira em	expires_at		date-time	Data/hora de expiração do pacote
Usos máximos	max_uses		integer	Número máximo de vezes que o pacote pode ser acessado
Observação	note		string	Nota interna do pacote
Senha	password		string	Senha para este pacote.
Paths	paths	True	array of string	Uma lista de caminhos a serem incluídos neste pacote.
Exigir registro	require_registration		boolean	Mostrar uma página de registro que captura o nome e o endereço de email do downloader?

Retornos

Nome	Caminho	Tipo	Description
codificar	code	string	Código do pacote. Esse código forma a parte final da URL Pública.
color_left	color_left	string	Link da página e cor do botão
color_link	color_link	string	Cor do link da barra superior
color_text	color_text	string	Link da página e cor do botão
color_top	color_top	string	Cor da tela de fundo da barra superior
color_top_text	color_top_text	string	Cor do texto da barra superior
url	url	string	URL pública do Link de Compartilhamento
descrição	description	string	Descrição pública
expira_em	expires_at	string	Data ou hora de expiração do pacote
password_protected	password_protected	boolean	Esse pacote é protegido por senha?
permissões	permissions	string	Permissões que se aplicam a Pastas neste Link de Compartilhamento.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Mostrar uma página de registro que captura o nome e o endereço de email do downloader?
require_share_recipient	require_share_recipient	boolean	Permitir apenas o acesso aos destinatários que receberam explicitamente o compartilhamento por meio de um email enviado pela interface do usuário do Files.com?
require_logout	require_logout	boolean	Se for true, ocultaremos a caixa 'Lembrar-me' na página de registro do Pacote, exigindo que o usuário faça logoff e faça logoff sempre que visitar a página.
clickwrap_body	clickwrap_body	string	Texto legal que deve ser acordado antes de acessar o Pacote.
id	form_field_set.id	integer	ID do conjunto de campos de formulário
title	form_field_set.title	string	Título a ser exibido
form_layout	form_field_set.form_layout	array of integer	Layout do formulário
form_fields	form_field_set.form_fields	array of object	Campos de formulário associados
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer o nome
skip_email	form_field_set.skip_email	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer email
skip_company	form_field_set.skip_company	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer a empresa
in_use	form_field_set.in_use	boolean	O Conjunto de Campos de Formulário está em uso por uma caixa de entrada ativa ou pacote ou registro de caixa de entrada ou registro de pacote
skip_name	skip_name	boolean	BundleRegistrations pode ser salvo sem fornecer o nome?
skip_email	skip_email	boolean	BundleRegistrations pode ser salvo sem fornecer email?
start_access_on_date	start_access_on_date	string	Data em que o compartilhamento começará a ser acessível. Se `nil` o acesso for concedido logo após a criação.
skip_company	skip_company	boolean	Os BundleRegistrations podem ser salvos sem fornecer a empresa?
id	id	integer	ID do pacote
criado_em	created_at	string	Pacote criado em data ou hora
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Não crie subpastas para arquivos carregados neste compartilhamento. Observação: há armadilhas de segurança sutis com a permissão de uploads anônimos de vários usuários para viver na mesma pasta. Desencorajamos fortemente o uso dessa opção, a menos que seja absolutamente necessário.
max_uses	max_uses	integer	Número máximo de vezes que o pacote pode ser acessado
nota	note	string	Nota interna do pacote
path_template	path_template	string	Modelo para criar subpastas de envio. Pode usar o nome do carregador, o endereço de email, o ip, a empresa, `strftime` as diretivas e quaisquer dados de formulário personalizados.
path_template_time_zone	path_template_time_zone	string	Fuso horário a ser usado ao renderizar carimbos de data/hora em modelos de caminho.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Envie o recibo de entrega para o carregador. Observação: somente para compartilhamento gravável
snapshot_id	snapshot_id	integer	ID do instantâneo que contém o conteúdo desse pacote.
id_do_usuário	user_id	integer	ID do usuário do criador do pacote
nome de usuário	username	string	Nome de usuário do criador do pacote
clickwrap_id	clickwrap_id	integer	ID do clickwrap a ser usado com esse pacote.
inbox_id	inbox_id	integer	ID da caixa de entrada associada, se disponível.
nome	watermark_attachment.name	string	Nome da imagem
uri	watermark_attachment.uri	string	URI da imagem
watermark_value	watermark_value	object	Visualizar as configurações de marca d'água aplicadas a todos os itens de pacote. Usa as mesmas chaves que Behavior.value
has_inbox	has_inbox	boolean	Esse pacote tem uma caixa de entrada associada?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Os uploads de pasta devem ser evitados?
Caminhos	paths	array of string	Uma lista de caminhos neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
bundlepaths	bundlepaths	array of object	Uma lista de bundlepaths neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
items	bundlepaths	object

Criar notificação do Link de Compartilhamento

ID da operação:: PostBundleNotifications

Criar notificação do Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pacote	bundle_id	True	integer	ID do pacote para notificar sobre
Notificar a ID do Usuário	notify_user_id		integer	A ID do usuário a ser notificada.

Retornos

Nome	Caminho	Tipo	Description
bundle_id	bundle_id	integer	ID do pacote para notificar sobre
id	id	integer	ID de notificação do pacote
notify_on_registration	notify_on_registration	boolean	Dispara a notificação de pacote quando ocorre uma ação de registro para ela.
notify_on_upload	notify_on_upload	boolean	Dispara a notificação de pacote quando uma ação de upload ocorre para ela.
notify_user_id	notify_user_id	integer	A ID do usuário a ser notificada.

Criar pasta

ID da operação:: PostFoldersPath

Criar pasta

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.

Retornos

Nome	Caminho	Tipo	Description
caminho	path	string	Caminho do arquivo ou da pasta. Isso deve ser delimitado por barra, mas não deve iniciar nem terminar com uma barra. Máximo de 5.000 caracteres.
created_by_id	created_by_id	integer	ID do usuário que criou o arquivo ou pasta
created_by_api_key_id	created_by_api_key_id	integer	ID da chave de API que criou o arquivo ou pasta
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	ID da Mensagem de Entrada AS2 que criou o arquivo ou a pasta
created_by_automation_id	created_by_automation_id	integer	ID da Automação que criou o arquivo ou pasta
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	ID do Registro de Pacote que criou o arquivo ou pasta
created_by_inbox_id	created_by_inbox_id	integer	ID da caixa de entrada que criou o arquivo ou pasta
created_by_remote_server_id	created_by_remote_server_id	integer	ID do Servidor Remoto que criou o arquivo ou pasta
created_by_sync_id	created_by_sync_id	integer	ID da Sincronização que criou o arquivo ou pasta
custom_metadata	custom_metadata	object	Mapa de metadados personalizado de chaves e valores. Limitado a 32 chaves, 256 caracteres por chave e 1.024 caracteres por valor.
display_name	display_name	string	Nome de exibição de arquivo ou pasta
tipo	type	string	Tipo: `directory` ou `file`.
size	size	integer	Tamanho do arquivo ou da pasta
criado_em	created_at	string	Data ou hora criada pelo arquivo
last_modified_by_id	last_modified_by_id	integer	ID do usuário que modificou o arquivo ou a pasta pela última vez
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	ID da chave de API que modificou o arquivo ou a pasta pela última vez
last_modified_by_automation_id	last_modified_by_automation_id	integer	ID da Automação que modificou o arquivo ou a pasta pela última vez
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	ID do Registro de Pacote que modificou o arquivo ou pasta pela última vez
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	ID do Servidor Remoto que modificou o arquivo ou a pasta pela última vez
last_modified_by_sync_id	last_modified_by_sync_id	integer	ID da Sincronização que modificou o arquivo ou a pasta pela última vez
Mtime	mtime	string	Data ou hora da última modificação do arquivo, de acordo com o servidor. Esse é o carimbo de data/hora da última operação de Files.com do arquivo, independentemente do carimbo de data/hora modificado enviado.
provided_mtime	provided_mtime	string	Data ou hora da última modificação do arquivo, de acordo com o cliente que o definiu. Files.com permite que clientes de área de trabalho, FTP, SFTP e WebDAV defina modificados às vezes. Isso permite que a sincronização desktop-nuvem<> preserve as modificações às vezes.
crc32	crc32	string	Soma de verificação CRC32 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
md5	md5	string	Soma de verificação MD5 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
sha1	sha1	string	Soma de verificação SHA1 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
sha256	sha256	string	Soma de verificação SHA256 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
tipo_de_mime	mime_type	string	Tipo MIME. Isso é determinado pela extensão filename e não é armazenado separadamente internamente.
região	region	string	Local da região
permissões	permissions	string	Uma cadeia de caracteres curta que representa as permissões do usuário atual. Pode ser `r` (Leitura),`w` (Gravação),`d` (Exclusão), `l` (Lista) ou qualquer combinação
subfolders_locked?	subfolders_locked?	boolean	As subpastas estão bloqueadas e não podem ser modificadas?
is_locked	is_locked	boolean	Esta pasta está bloqueada e não pode ser modificada?
download_uri	download_uri	string	Link para baixar o arquivo. Fornecido apenas em resposta a uma solicitação de download.
priority_color	priority_color	string	Indicador ou cor de prioridade do arquivo ou pasta
preview_id	preview_id	integer	ID da visualização do arquivo
id	preview.id	integer	ID de visualização
status	preview.status	string	Status de visualização. Pode ser inválido, not_generated, gerando, concluído ou file_too_large
download_uri	preview.download_uri	string	Link para baixar a versão prévia
tipo	preview.type	string	Tipo de visualização. Pode ser imagem, pdf, pdf_native, vídeo ou áudio
size	preview.size	string	Tamanho da visualização

Criar uma nova conta de usuário para o grupo

ID da operação:: PostGroupsGroupIdUsers

Criar uma nova conta de usuário para o grupo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	group_id	True	integer	ID do grupo ao qual associar esse usuário.
Método de autenticação	authentication_method		string	Como esse usuário é autenticado?
Empresa	company		string	Empresa do usuário
Email	email		string	Email do usuário.
IDs de grupo	group_ids		string	Uma lista de IDs de grupo à qual associar esse usuário. Vírgula delimitada.
Nome	name		string	Nome completo do usuário
Anotações	notes		string	Quaisquer anotações internas sobre o usuário
Senha	password		string	Senha do usuário.
Exigir alteração de senha	require_password_change		boolean	Uma alteração de senha é necessária no logon do próximo usuário?
Página Inicial do Usuário	user_home		string	Pasta inicial para FTP/SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Raiz do Usuário	user_root		string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Nome de usuário	username	True	string	Nome de usuário do usuário

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do Usuário
nome de usuário	username	string	Nome de usuário do usuário
admin_group_ids	admin_group_ids	array of integer	Lista de IDs de grupo das quais esse usuário é um administrador
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
attachments_permission	attachments_permission	boolean	Se `true`, o usuário pode criar pacotes (também conhecidos como Links de Compartilhamento). Em vez disso, use a permissão do pacote.
api_keys_count	api_keys_count	integer	Número de chaves de API associadas a esse usuário
authenticate_until	authenticate_until	string	Data ou hora agendadas em que o usuário será desativado
authentication_method	authentication_method	string	Como esse usuário é autenticado?
avatar_url	avatar_url	string	URL que contém o avatar do usuário
Faturável	billable	boolean	Este é um registro de usuário faturável?
billing_permission	billing_permission	boolean	Permitir que esse usuário execute operações na conta, pagamentos e faturas?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Permitir que esse usuário ignore listas negras de IP em todo o site?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Isentar esse usuário das regras de ciclo de vida do usuário?
criado_em	created_at	string	Quando esse usuário foi criado
dav_permission	dav_permission	boolean	O usuário pode se conectar ao WebDAV?
desabilitado	disabled	boolean	O usuário está desabilitado? Os usuários desabilitados não podem fazer logon e não contam para fins de cobrança. Os usuários podem ser desabilitados automaticamente após um período de inatividade por meio de uma configuração do Site ou agendamento a ser desativado após uma data específica.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Propriedade computada que retorna true se o usuário desabilitado ou expirado ou inativo.
email	email	string	Endereço de email do usuário
filesystem_layout	filesystem_layout	string	Layout do sistema de arquivos
first_login_at	first_login_at	string	Primeira vez de logon do usuário
ftp_permission	ftp_permission	boolean	O usuário pode acessar com FTP ou FTPS?
group_ids	group_ids	string	Lista separada por vírgulas de IDs de grupo das quais esse usuário é membro
header_text	header_text	string	Texto a ser exibido para o usuário no cabeçalho da interface do usuário
linguagem	language	string	Idioma preferencial
last_login_at	last_login_at	string	Hora de logon mais recente do usuário por meio de qualquer protocolo
last_web_login_at	last_web_login_at	string	Hora de logon mais recente do usuário via Web
last_ftp_login_at	last_ftp_login_at	string	Hora de logon mais recente do usuário via FTP
last_sftp_login_at	last_sftp_login_at	string	Tempo de logon mais recente do usuário via SFTP
last_dav_login_at	last_dav_login_at	string	Hora de logon mais recente do usuário via WebDAV
last_desktop_login_at	last_desktop_login_at	string	Hora de logon mais recente do usuário por meio do aplicativo desktop
last_restapi_login_at	last_restapi_login_at	string	Tempo de logon mais recente do usuário por meio da API Rest
last_api_use_at	last_api_use_at	string	Tempo de uso mais recente da API do usuário
última_atividade_em	last_active_at	string	O tempo de atividade mais recente do usuário, que é o mais recente do logon mais recente, o uso, a habilitação ou a criação da API mais recente
last_protocol_cipher	last_protocol_cipher	string	O protocolo e a criptografia mais recentes usados
lockout_expires	lockout_expires	string	Hora no futuro em que o usuário não será mais bloqueado se aplicável
nome	name	string	Nome completo do usuário
empresa	company	string	Empresa do usuário
notas	notes	string	Quaisquer anotações internas sobre o usuário
notification_daily_send_time	notification_daily_send_time	integer	Hora do dia em que as notificações diárias devem ser enviadas. Pode estar no intervalo de 0 a 23
office_integration_enabled	office_integration_enabled	boolean	Habilitar a integração com o Office para a Web?
partner_admin	partner_admin	boolean	Esse usuário é um administrador de parceiros?
partner_id	partner_id	integer	ID do parceiro se este usuário pertencer a um Parceiro
partner_name	partner_name	string	Nome do Parceiro se este usuário pertencer a um Parceiro
password_set_at	password_set_at	string	Última vez que a senha do usuário foi definida
password_validity_days	password_validity_days	integer	Número de dias para permitir que o usuário use a mesma senha
public_keys_count	public_keys_count	integer	Número de chaves públicas associadas a esse usuário
receive_admin_alerts	receive_admin_alerts	boolean	O usuário deve receber alertas de administrador, como notificações de expiração de certificado e excessos?
require_2fa	require_2fa	string	Configuração necessária para 2FA
require_login_by	require_login_by	string	Exija que o usuário faça logon por data especificada, caso contrário, ele será desabilitado.
active_2fa	active_2fa	boolean	O 2fa está ativo para o usuário?
require_password_change	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
password_expired	password_expired	boolean	A senha do usuário expirou?
readonly_site_admin	readonly_site_admin	boolean	O usuário tem permissão para exibir todas as configurações de site (sem cobrança) deste site?
restapi_permission	restapi_permission	boolean	Esse usuário pode acessar o aplicativo Web, o aplicativo da área de trabalho, os SDKs ou a API REST? (Todas essas ferramentas usam a API internamente, portanto, esse é um conjunto de permissões unificado.)
self_managed	self_managed	boolean	Esse usuário gerencia suas próprias credenciais ou é um usuário compartilhado ou bot?
sftp_permission	sftp_permission	boolean	O usuário pode acessar com o SFTP?
site_admin	site_admin	boolean	O usuário é um administrador para este site?
site_id	site_id	integer	ID do Site
skip_welcome_screen	skip_welcome_screen	boolean	Ignorar a página de boas-vindas na interface do usuário?
ssl_required	ssl_required	string	Configuração necessária para SSL
sso_strategy_id	sso_strategy_id	integer	ID de estratégia de SSO (Logon Único) para o usuário, se aplicável.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	O usuário está inscrito no boletim informativo?
externally_managed	externally_managed	boolean	Esse usuário é gerenciado por um SsoStrategy?
tags	tags	string	Lista separada por vírgulas de Marcas para este usuário. As marcas são usadas para outros recursos, como UserLifecycleRules, que podem direcionar marcas específicas. As marcas devem conter apenas letras minúsculas, números e hifens.
fuso horário	time_zone	string	Fuso horário do usuário
type_of_2fa	type_of_2fa	string	Tipos de métodos 2FA em uso para uso programático. `sms`Serão, , `totp`, `webauthn`, `yubi`, `email`ou vários valores classificados em ordem alfabética e unidos por um sublinhado. Não especifica se o usuário tem mais de um de um determinado método.
type_of_2fa_for_display	type_of_2fa_for_display	string	Tipos de métodos 2FA em uso, formatados para exibição na interface do usuário. Diferentemente `type_of_2fa`disso, esse valor deixará claro quando um usuário tiver mais de 1 do mesmo tipo de método.
user_root	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
user_home	user_home	string	Pasta inicial para FTP ou SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Número de dias restantes até que a senha expire
password_expire_at	password_expire_at	string	Datetime de expiração de senha

Criar Usuário

ID da operação:: PostUsers

Criar Usuário

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Método de autenticação	authentication_method		string	Como esse usuário é autenticado?
Empresa	company		string	Empresa do usuário
Email	email		string	Email do usuário.
IDs de grupo	group_ids		string	Uma lista de IDs de grupo à qual associar esse usuário. Vírgula delimitada.
Nome	name		string	Nome completo do usuário
Anotações	notes		string	Quaisquer anotações internas sobre o usuário
Senha	password		string	Senha do usuário.
Exigir alteração de senha	require_password_change		boolean	Uma alteração de senha é necessária no logon do próximo usuário?
Página Inicial do Usuário	user_home		string	Pasta inicial para FTP/SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Raiz do Usuário	user_root		string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
Nome de usuário	username	True	string	Nome de usuário do usuário

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do Usuário
nome de usuário	username	string	Nome de usuário do usuário
admin_group_ids	admin_group_ids	array of integer	Lista de IDs de grupo das quais esse usuário é um administrador
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
attachments_permission	attachments_permission	boolean	Se `true`, o usuário pode criar pacotes (também conhecidos como Links de Compartilhamento). Em vez disso, use a permissão do pacote.
api_keys_count	api_keys_count	integer	Número de chaves de API associadas a esse usuário
authenticate_until	authenticate_until	string	Data ou hora agendadas em que o usuário será desativado
authentication_method	authentication_method	string	Como esse usuário é autenticado?
avatar_url	avatar_url	string	URL que contém o avatar do usuário
Faturável	billable	boolean	Este é um registro de usuário faturável?
billing_permission	billing_permission	boolean	Permitir que esse usuário execute operações na conta, pagamentos e faturas?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Permitir que esse usuário ignore listas negras de IP em todo o site?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Isentar esse usuário das regras de ciclo de vida do usuário?
criado_em	created_at	string	Quando esse usuário foi criado
dav_permission	dav_permission	boolean	O usuário pode se conectar ao WebDAV?
desabilitado	disabled	boolean	O usuário está desabilitado? Os usuários desabilitados não podem fazer logon e não contam para fins de cobrança. Os usuários podem ser desabilitados automaticamente após um período de inatividade por meio de uma configuração do Site ou agendamento a ser desativado após uma data específica.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Propriedade computada que retorna true se o usuário desabilitado ou expirado ou inativo.
email	email	string	Endereço de email do usuário
filesystem_layout	filesystem_layout	string	Layout do sistema de arquivos
first_login_at	first_login_at	string	Primeira vez de logon do usuário
ftp_permission	ftp_permission	boolean	O usuário pode acessar com FTP ou FTPS?
group_ids	group_ids	string	Lista separada por vírgulas de IDs de grupo das quais esse usuário é membro
header_text	header_text	string	Texto a ser exibido para o usuário no cabeçalho da interface do usuário
linguagem	language	string	Idioma preferencial
last_login_at	last_login_at	string	Hora de logon mais recente do usuário por meio de qualquer protocolo
last_web_login_at	last_web_login_at	string	Hora de logon mais recente do usuário via Web
last_ftp_login_at	last_ftp_login_at	string	Hora de logon mais recente do usuário via FTP
last_sftp_login_at	last_sftp_login_at	string	Tempo de logon mais recente do usuário via SFTP
last_dav_login_at	last_dav_login_at	string	Hora de logon mais recente do usuário via WebDAV
last_desktop_login_at	last_desktop_login_at	string	Hora de logon mais recente do usuário por meio do aplicativo desktop
last_restapi_login_at	last_restapi_login_at	string	Tempo de logon mais recente do usuário por meio da API Rest
last_api_use_at	last_api_use_at	string	Tempo de uso mais recente da API do usuário
última_atividade_em	last_active_at	string	O tempo de atividade mais recente do usuário, que é o mais recente do logon mais recente, o uso, a habilitação ou a criação da API mais recente
last_protocol_cipher	last_protocol_cipher	string	O protocolo e a criptografia mais recentes usados
lockout_expires	lockout_expires	string	Hora no futuro em que o usuário não será mais bloqueado se aplicável
nome	name	string	Nome completo do usuário
empresa	company	string	Empresa do usuário
notas	notes	string	Quaisquer anotações internas sobre o usuário
notification_daily_send_time	notification_daily_send_time	integer	Hora do dia em que as notificações diárias devem ser enviadas. Pode estar no intervalo de 0 a 23
office_integration_enabled	office_integration_enabled	boolean	Habilitar a integração com o Office para a Web?
partner_admin	partner_admin	boolean	Esse usuário é um administrador de parceiros?
partner_id	partner_id	integer	ID do parceiro se este usuário pertencer a um Parceiro
partner_name	partner_name	string	Nome do Parceiro se este usuário pertencer a um Parceiro
password_set_at	password_set_at	string	Última vez que a senha do usuário foi definida
password_validity_days	password_validity_days	integer	Número de dias para permitir que o usuário use a mesma senha
public_keys_count	public_keys_count	integer	Número de chaves públicas associadas a esse usuário
receive_admin_alerts	receive_admin_alerts	boolean	O usuário deve receber alertas de administrador, como notificações de expiração de certificado e excessos?
require_2fa	require_2fa	string	Configuração necessária para 2FA
require_login_by	require_login_by	string	Exija que o usuário faça logon por data especificada, caso contrário, ele será desabilitado.
active_2fa	active_2fa	boolean	O 2fa está ativo para o usuário?
require_password_change	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
password_expired	password_expired	boolean	A senha do usuário expirou?
readonly_site_admin	readonly_site_admin	boolean	O usuário tem permissão para exibir todas as configurações de site (sem cobrança) deste site?
restapi_permission	restapi_permission	boolean	Esse usuário pode acessar o aplicativo Web, o aplicativo da área de trabalho, os SDKs ou a API REST? (Todas essas ferramentas usam a API internamente, portanto, esse é um conjunto de permissões unificado.)
self_managed	self_managed	boolean	Esse usuário gerencia suas próprias credenciais ou é um usuário compartilhado ou bot?
sftp_permission	sftp_permission	boolean	O usuário pode acessar com o SFTP?
site_admin	site_admin	boolean	O usuário é um administrador para este site?
site_id	site_id	integer	ID do Site
skip_welcome_screen	skip_welcome_screen	boolean	Ignorar a página de boas-vindas na interface do usuário?
ssl_required	ssl_required	string	Configuração necessária para SSL
sso_strategy_id	sso_strategy_id	integer	ID de estratégia de SSO (Logon Único) para o usuário, se aplicável.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	O usuário está inscrito no boletim informativo?
externally_managed	externally_managed	boolean	Esse usuário é gerenciado por um SsoStrategy?
tags	tags	string	Lista separada por vírgulas de Marcas para este usuário. As marcas são usadas para outros recursos, como UserLifecycleRules, que podem direcionar marcas específicas. As marcas devem conter apenas letras minúsculas, números e hifens.
fuso horário	time_zone	string	Fuso horário do usuário
type_of_2fa	type_of_2fa	string	Tipos de métodos 2FA em uso para uso programático. `sms`Serão, , `totp`, `webauthn`, `yubi`, `email`ou vários valores classificados em ordem alfabética e unidos por um sublinhado. Não especifica se o usuário tem mais de um de um determinado método.
type_of_2fa_for_display	type_of_2fa_for_display	string	Tipos de métodos 2FA em uso, formatados para exibição na interface do usuário. Diferentemente `type_of_2fa`disso, esse valor deixará claro quando um usuário tiver mais de 1 do mesmo tipo de método.
user_root	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
user_home	user_home	string	Pasta inicial para FTP ou SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Número de dias restantes até que a senha expire
password_expire_at	password_expire_at	string	Datetime de expiração de senha

Excluir arquivo ou pasta

ID da operação:: DeleteFilesPath

Excluir arquivo ou pasta

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.

Excluir grupo

ID da operação:: DeleteGroupsId

Excluir grupo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID do grupo.

Excluir Link de Compartilhamento

ID da operação:: DeleteBundlesId

Excluir Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID do pacote.

Excluir Notificação de Link de Compartilhamento

ID da operação:: DeleteBundleNotificationsId

Excluir Notificação de Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID de notificação do pacote.

Excluir usuário

ID da operação:: DeleteUsersId

Excluir usuário

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID de usuário.

Listar destinatários de link de compartilhamento

ID da operação:: GetBundleRecipients

Listar destinatários de link de compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pacote	bundle_id	True	integer	Listar destinatários para o pacote com essa ID.

Retornos

Nome	Caminho	Tipo	Description
		array of object
empresa	company	string	A empresa do destinatário.
nome	name	string	O nome do destinatário.
nota	note	string	Uma nota enviada ao destinatário com o pacote.
destinatário	recipient	string	O endereço de email do destinatário.
sent_at	sent_at	string	Quando o Pacote foi compartilhado com esse destinatário.

Listar downloads de link de compartilhamento

ID da operação:: GetBundleDownloads

Listar downloads de link de compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pacote	bundle_id		integer	ID do pacote

Retornos

Nome	Caminho	Tipo	Description
		array of object
codificar	bundle_registration.code	string	Código de cookie de registro
nome	bundle_registration.name	string	Nome do registrador
empresa	bundle_registration.company	string	Nome da empresa registrador
email	bundle_registration.email	string	Endereço de email do registrador
ip	bundle_registration.ip	string	Endereço IP do registrador
inbox_code	bundle_registration.inbox_code	string	Código de cookie InboxRegistration, se houver uma InboxRegistration associada
clickwrap_body	bundle_registration.clickwrap_body	string	Texto de clickwrap que foi mostrado para o registrador
form_field_set_id	bundle_registration.form_field_set_id	integer	ID do conjunto de campos de formulário associado
form_field_data	bundle_registration.form_field_data	object	Dados para o campo de formulário definido com IDs de campo de formulário como chaves e dados do usuário como valores
bundle_code	bundle_registration.bundle_code	string	Código de URL do pacote
bundle_id	bundle_registration.bundle_id	integer	ID do pacote associado
bundle_recipient_id	bundle_registration.bundle_recipient_id	integer	ID do destinatário do pacote associado
criado_em	bundle_registration.created_at	string	Data ou hora de criação do registro
download_method	download_method	string	Método download (arquivo ou full_zip)
caminho	path	string	Caminho de download. Isso deve ser delimitado por barra, mas não deve iniciar nem terminar com uma barra. Máximo de 5.000 caracteres.
criado_em	created_at	string	Data ou hora do download

Listar grupos

ID da operação:: GetGroups

Listar grupos

Retornos

Nome	Caminho	Tipo	Description
		array of object
id	id	integer	ID do grupo
nome	name	string	Nome do grupo
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
admin_ids	admin_ids	string	Lista delimitada por vírgulas de IDs de usuário que são administradores de grupo (separadas por vírgulas)
notas	notes	string	Anotações sobre esse grupo
user_ids	user_ids	string	Lista delimitada por vírgulas de IDs de usuário que pertencem a esse grupo (separadas por vírgulas)
usernames	usernames	string	Lista delimitada por vírgulas de nomes de usuário que pertencem a esse grupo (separados por vírgulas)
ftp_permission	ftp_permission	boolean	Se for true, os usuários desse grupo poderão usar FTP para fazer logon. Isso substituirá um valor falso no nível do `ftp_permission` usuário.
sftp_permission	sftp_permission	boolean	Se for true, os usuários desse grupo poderão usar o SFTP para fazer logon. Isso substituirá um valor falso no nível do `sftp_permission` usuário.
dav_permission	dav_permission	boolean	Se for true, os usuários desse grupo poderão usar o WebDAV para fazer logon. Isso substituirá um valor falso no nível do `dav_permission` usuário.
restapi_permission	restapi_permission	boolean	Se for true, os usuários desse grupo poderão usar a API REST para fazer logon. Isso substituirá um valor falso no nível do `restapi_permission` usuário.
site_id	site_id	integer	ID do Site

Listar Links de Compartilhamento

ID da operação:: GetBundles

Listar Links de Compartilhamento

Retornos

Nome	Caminho	Tipo	Description
		array of object
codificar	code	string	Código do pacote. Esse código forma a parte final da URL Pública.
color_left	color_left	string	Link da página e cor do botão
color_link	color_link	string	Cor do link da barra superior
color_text	color_text	string	Link da página e cor do botão
color_top	color_top	string	Cor da tela de fundo da barra superior
color_top_text	color_top_text	string	Cor do texto da barra superior
url	url	string	URL pública do Link de Compartilhamento
descrição	description	string	Descrição pública
expira_em	expires_at	string	Data ou hora de expiração do pacote
password_protected	password_protected	boolean	Esse pacote é protegido por senha?
permissões	permissions	string	Permissões que se aplicam a Pastas neste Link de Compartilhamento.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Mostrar uma página de registro que captura o nome e o endereço de email do downloader?
require_share_recipient	require_share_recipient	boolean	Permitir apenas o acesso aos destinatários que receberam explicitamente o compartilhamento por meio de um email enviado pela interface do usuário do Files.com?
require_logout	require_logout	boolean	Se for true, ocultaremos a caixa 'Lembrar-me' na página de registro do Pacote, exigindo que o usuário faça logoff e faça logoff sempre que visitar a página.
clickwrap_body	clickwrap_body	string	Texto legal que deve ser acordado antes de acessar o Pacote.
id	form_field_set.id	integer	ID do conjunto de campos de formulário
title	form_field_set.title	string	Título a ser exibido
form_layout	form_field_set.form_layout	array of integer	Layout do formulário
form_fields	form_field_set.form_fields	array of object	Campos de formulário associados
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer o nome
skip_email	form_field_set.skip_email	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer email
skip_company	form_field_set.skip_company	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer a empresa
in_use	form_field_set.in_use	boolean	O Conjunto de Campos de Formulário está em uso por uma caixa de entrada ativa ou pacote ou registro de caixa de entrada ou registro de pacote
skip_name	skip_name	boolean	BundleRegistrations pode ser salvo sem fornecer o nome?
skip_email	skip_email	boolean	BundleRegistrations pode ser salvo sem fornecer email?
start_access_on_date	start_access_on_date	string	Data em que o compartilhamento começará a ser acessível. Se `nil` o acesso for concedido logo após a criação.
skip_company	skip_company	boolean	Os BundleRegistrations podem ser salvos sem fornecer a empresa?
id	id	integer	ID do pacote
criado_em	created_at	string	Pacote criado em data ou hora
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Não crie subpastas para arquivos carregados neste compartilhamento. Observação: há armadilhas de segurança sutis com a permissão de uploads anônimos de vários usuários para viver na mesma pasta. Desencorajamos fortemente o uso dessa opção, a menos que seja absolutamente necessário.
max_uses	max_uses	integer	Número máximo de vezes que o pacote pode ser acessado
nota	note	string	Nota interna do pacote
path_template	path_template	string	Modelo para criar subpastas de envio. Pode usar o nome do carregador, o endereço de email, o ip, a empresa, `strftime` as diretivas e quaisquer dados de formulário personalizados.
path_template_time_zone	path_template_time_zone	string	Fuso horário a ser usado ao renderizar carimbos de data/hora em modelos de caminho.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Envie o recibo de entrega para o carregador. Observação: somente para compartilhamento gravável
snapshot_id	snapshot_id	integer	ID do instantâneo que contém o conteúdo desse pacote.
id_do_usuário	user_id	integer	ID do usuário do criador do pacote
nome de usuário	username	string	Nome de usuário do criador do pacote
clickwrap_id	clickwrap_id	integer	ID do clickwrap a ser usado com esse pacote.
inbox_id	inbox_id	integer	ID da caixa de entrada associada, se disponível.
nome	watermark_attachment.name	string	Nome da imagem
uri	watermark_attachment.uri	string	URI da imagem
watermark_value	watermark_value	object	Visualizar as configurações de marca d'água aplicadas a todos os itens de pacote. Usa as mesmas chaves que Behavior.value
has_inbox	has_inbox	boolean	Esse pacote tem uma caixa de entrada associada?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Os uploads de pasta devem ser evitados?
Caminhos	paths	array of string	Uma lista de caminhos neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
bundlepaths	bundlepaths	array of object	Uma lista de bundlepaths neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
items	bundlepaths	object

Listar notificações de link de compartilhamento

ID da operação:: GetBundleNotifications

Listar notificações de link de compartilhamento

Retornos

Nome	Caminho	Tipo	Description
		array of object
bundle_id	bundle_id	integer	ID do pacote para notificar sobre
id	id	integer	ID de notificação do pacote
notify_on_registration	notify_on_registration	boolean	Dispara a notificação de pacote quando ocorre uma ação de registro para ela.
notify_on_upload	notify_on_upload	boolean	Dispara a notificação de pacote quando uma ação de upload ocorre para ela.
notify_user_id	notify_user_id	integer	A ID do usuário a ser notificada.

Listar pastas por caminho

ID da operação:: FolderListForPath

Listar pastas por caminho

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.

Retornos

Nome	Caminho	Tipo	Description
		array of object
caminho	path	string	Caminho do arquivo ou da pasta. Isso deve ser delimitado por barra, mas não deve iniciar nem terminar com uma barra. Máximo de 5.000 caracteres.
created_by_id	created_by_id	integer	ID do usuário que criou o arquivo ou pasta
created_by_api_key_id	created_by_api_key_id	integer	ID da chave de API que criou o arquivo ou pasta
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	ID da Mensagem de Entrada AS2 que criou o arquivo ou a pasta
created_by_automation_id	created_by_automation_id	integer	ID da Automação que criou o arquivo ou pasta
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	ID do Registro de Pacote que criou o arquivo ou pasta
created_by_inbox_id	created_by_inbox_id	integer	ID da caixa de entrada que criou o arquivo ou pasta
created_by_remote_server_id	created_by_remote_server_id	integer	ID do Servidor Remoto que criou o arquivo ou pasta
created_by_sync_id	created_by_sync_id	integer	ID da Sincronização que criou o arquivo ou pasta
custom_metadata	custom_metadata	object	Mapa de metadados personalizado de chaves e valores. Limitado a 32 chaves, 256 caracteres por chave e 1.024 caracteres por valor.
display_name	display_name	string	Nome de exibição de arquivo ou pasta
tipo	type	string	Tipo: `directory` ou `file`.
size	size	integer	Tamanho do arquivo ou da pasta
criado_em	created_at	string	Data ou hora criada pelo arquivo
last_modified_by_id	last_modified_by_id	integer	ID do usuário que modificou o arquivo ou a pasta pela última vez
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	ID da chave de API que modificou o arquivo ou a pasta pela última vez
last_modified_by_automation_id	last_modified_by_automation_id	integer	ID da Automação que modificou o arquivo ou a pasta pela última vez
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	ID do Registro de Pacote que modificou o arquivo ou pasta pela última vez
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	ID do Servidor Remoto que modificou o arquivo ou a pasta pela última vez
last_modified_by_sync_id	last_modified_by_sync_id	integer	ID da Sincronização que modificou o arquivo ou a pasta pela última vez
Mtime	mtime	string	Data ou hora da última modificação do arquivo, de acordo com o servidor. Esse é o carimbo de data/hora da última operação de Files.com do arquivo, independentemente do carimbo de data/hora modificado enviado.
provided_mtime	provided_mtime	string	Data ou hora da última modificação do arquivo, de acordo com o cliente que o definiu. Files.com permite que clientes de área de trabalho, FTP, SFTP e WebDAV defina modificados às vezes. Isso permite que a sincronização desktop-nuvem<> preserve as modificações às vezes.
crc32	crc32	string	Soma de verificação CRC32 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
md5	md5	string	Soma de verificação MD5 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
sha1	sha1	string	Soma de verificação SHA1 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
sha256	sha256	string	Soma de verificação SHA256 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
tipo_de_mime	mime_type	string	Tipo MIME. Isso é determinado pela extensão filename e não é armazenado separadamente internamente.
região	region	string	Local da região
permissões	permissions	string	Uma cadeia de caracteres curta que representa as permissões do usuário atual. Pode ser `r` (Leitura),`w` (Gravação),`d` (Exclusão), `l` (Lista) ou qualquer combinação
subfolders_locked?	subfolders_locked?	boolean	As subpastas estão bloqueadas e não podem ser modificadas?
is_locked	is_locked	boolean	Esta pasta está bloqueada e não pode ser modificada?
download_uri	download_uri	string	Link para baixar o arquivo. Fornecido apenas em resposta a uma solicitação de download.
priority_color	priority_color	string	Indicador ou cor de prioridade do arquivo ou pasta
preview_id	preview_id	integer	ID da visualização do arquivo
id	preview.id	integer	ID de visualização
status	preview.status	string	Status de visualização. Pode ser inválido, not_generated, gerando, concluído ou file_too_large
download_uri	preview.download_uri	string	Link para baixar a versão prévia
tipo	preview.type	string	Tipo de visualização. Pode ser imagem, pdf, pdf_native, vídeo ou áudio
size	preview.size	string	Tamanho da visualização

Listar registros de link de compartilhamento

ID da operação:: GetBundleRegistrations

Listar registros de link de compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pacote	bundle_id		integer	ID do pacote associado

Retornos

Nome	Caminho	Tipo	Description
		array of object
codificar	code	string	Código de cookie de registro
nome	name	string	Nome do registrador
empresa	company	string	Nome da empresa registrador
email	email	string	Endereço de email do registrador
ip	ip	string	Endereço IP do registrador
inbox_code	inbox_code	string	Código de cookie InboxRegistration, se houver uma InboxRegistration associada
clickwrap_body	clickwrap_body	string	Texto de clickwrap que foi mostrado para o registrador
form_field_set_id	form_field_set_id	integer	ID do conjunto de campos de formulário associado
form_field_data	form_field_data	object	Dados para o campo de formulário definido com IDs de campo de formulário como chaves e dados do usuário como valores
bundle_code	bundle_code	string	Código de URL do pacote
bundle_id	bundle_id	integer	ID do pacote associado
bundle_recipient_id	bundle_recipient_id	integer	ID do destinatário do pacote associado
criado_em	created_at	string	Data ou hora de criação do registro

Listar usuários

ID da operação:: GetUsers

Listar usuários

Retornos

Nome	Caminho	Tipo	Description
		array of object
id	id	integer	ID do Usuário
nome de usuário	username	string	Nome de usuário do usuário
admin_group_ids	admin_group_ids	array of integer	Lista de IDs de grupo das quais esse usuário é um administrador
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
attachments_permission	attachments_permission	boolean	Se `true`, o usuário pode criar pacotes (também conhecidos como Links de Compartilhamento). Em vez disso, use a permissão do pacote.
api_keys_count	api_keys_count	integer	Número de chaves de API associadas a esse usuário
authenticate_until	authenticate_until	string	Data ou hora agendadas em que o usuário será desativado
authentication_method	authentication_method	string	Como esse usuário é autenticado?
avatar_url	avatar_url	string	URL que contém o avatar do usuário
Faturável	billable	boolean	Este é um registro de usuário faturável?
billing_permission	billing_permission	boolean	Permitir que esse usuário execute operações na conta, pagamentos e faturas?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Permitir que esse usuário ignore listas negras de IP em todo o site?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Isentar esse usuário das regras de ciclo de vida do usuário?
criado_em	created_at	string	Quando esse usuário foi criado
dav_permission	dav_permission	boolean	O usuário pode se conectar ao WebDAV?
desabilitado	disabled	boolean	O usuário está desabilitado? Os usuários desabilitados não podem fazer logon e não contam para fins de cobrança. Os usuários podem ser desabilitados automaticamente após um período de inatividade por meio de uma configuração do Site ou agendamento a ser desativado após uma data específica.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Propriedade computada que retorna true se o usuário desabilitado ou expirado ou inativo.
email	email	string	Endereço de email do usuário
filesystem_layout	filesystem_layout	string	Layout do sistema de arquivos
first_login_at	first_login_at	string	Primeira vez de logon do usuário
ftp_permission	ftp_permission	boolean	O usuário pode acessar com FTP ou FTPS?
group_ids	group_ids	string	Lista separada por vírgulas de IDs de grupo das quais esse usuário é membro
header_text	header_text	string	Texto a ser exibido para o usuário no cabeçalho da interface do usuário
linguagem	language	string	Idioma preferencial
last_login_at	last_login_at	string	Hora de logon mais recente do usuário por meio de qualquer protocolo
last_web_login_at	last_web_login_at	string	Hora de logon mais recente do usuário via Web
last_ftp_login_at	last_ftp_login_at	string	Hora de logon mais recente do usuário via FTP
last_sftp_login_at	last_sftp_login_at	string	Tempo de logon mais recente do usuário via SFTP
last_dav_login_at	last_dav_login_at	string	Hora de logon mais recente do usuário via WebDAV
last_desktop_login_at	last_desktop_login_at	string	Hora de logon mais recente do usuário por meio do aplicativo desktop
last_restapi_login_at	last_restapi_login_at	string	Tempo de logon mais recente do usuário por meio da API Rest
last_api_use_at	last_api_use_at	string	Tempo de uso mais recente da API do usuário
última_atividade_em	last_active_at	string	O tempo de atividade mais recente do usuário, que é o mais recente do logon mais recente, o uso, a habilitação ou a criação da API mais recente
last_protocol_cipher	last_protocol_cipher	string	O protocolo e a criptografia mais recentes usados
lockout_expires	lockout_expires	string	Hora no futuro em que o usuário não será mais bloqueado se aplicável
nome	name	string	Nome completo do usuário
empresa	company	string	Empresa do usuário
notas	notes	string	Quaisquer anotações internas sobre o usuário
notification_daily_send_time	notification_daily_send_time	integer	Hora do dia em que as notificações diárias devem ser enviadas. Pode estar no intervalo de 0 a 23
office_integration_enabled	office_integration_enabled	boolean	Habilitar a integração com o Office para a Web?
partner_admin	partner_admin	boolean	Esse usuário é um administrador de parceiros?
partner_id	partner_id	integer	ID do parceiro se este usuário pertencer a um Parceiro
partner_name	partner_name	string	Nome do Parceiro se este usuário pertencer a um Parceiro
password_set_at	password_set_at	string	Última vez que a senha do usuário foi definida
password_validity_days	password_validity_days	integer	Número de dias para permitir que o usuário use a mesma senha
public_keys_count	public_keys_count	integer	Número de chaves públicas associadas a esse usuário
receive_admin_alerts	receive_admin_alerts	boolean	O usuário deve receber alertas de administrador, como notificações de expiração de certificado e excessos?
require_2fa	require_2fa	string	Configuração necessária para 2FA
require_login_by	require_login_by	string	Exija que o usuário faça logon por data especificada, caso contrário, ele será desabilitado.
active_2fa	active_2fa	boolean	O 2fa está ativo para o usuário?
require_password_change	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
password_expired	password_expired	boolean	A senha do usuário expirou?
readonly_site_admin	readonly_site_admin	boolean	O usuário tem permissão para exibir todas as configurações de site (sem cobrança) deste site?
restapi_permission	restapi_permission	boolean	Esse usuário pode acessar o aplicativo Web, o aplicativo da área de trabalho, os SDKs ou a API REST? (Todas essas ferramentas usam a API internamente, portanto, esse é um conjunto de permissões unificado.)
self_managed	self_managed	boolean	Esse usuário gerencia suas próprias credenciais ou é um usuário compartilhado ou bot?
sftp_permission	sftp_permission	boolean	O usuário pode acessar com o SFTP?
site_admin	site_admin	boolean	O usuário é um administrador para este site?
site_id	site_id	integer	ID do Site
skip_welcome_screen	skip_welcome_screen	boolean	Ignorar a página de boas-vindas na interface do usuário?
ssl_required	ssl_required	string	Configuração necessária para SSL
sso_strategy_id	sso_strategy_id	integer	ID de estratégia de SSO (Logon Único) para o usuário, se aplicável.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	O usuário está inscrito no boletim informativo?
externally_managed	externally_managed	boolean	Esse usuário é gerenciado por um SsoStrategy?
tags	tags	string	Lista separada por vírgulas de Marcas para este usuário. As marcas são usadas para outros recursos, como UserLifecycleRules, que podem direcionar marcas específicas. As marcas devem conter apenas letras minúsculas, números e hifens.
fuso horário	time_zone	string	Fuso horário do usuário
type_of_2fa	type_of_2fa	string	Tipos de métodos 2FA em uso para uso programático. `sms`Serão, , `totp`, `webauthn`, `yubi`, `email`ou vários valores classificados em ordem alfabética e unidos por um sublinhado. Não especifica se o usuário tem mais de um de um determinado método.
type_of_2fa_for_display	type_of_2fa_for_display	string	Tipos de métodos 2FA em uso, formatados para exibição na interface do usuário. Diferentemente `type_of_2fa`disso, esse valor deixará claro quando um usuário tiver mais de 1 do mesmo tipo de método.
user_root	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
user_home	user_home	string	Pasta inicial para FTP ou SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Número de dias restantes até que a senha expire
password_expire_at	password_expire_at	string	Datetime de expiração de senha

Localizar arquivo ou pasta por caminho

ID da operação:: FileActionFind

Localizar arquivo ou pasta por caminho

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.

Retornos

Nome	Caminho	Tipo	Description
caminho	path	string	Caminho do arquivo ou da pasta. Isso deve ser delimitado por barra, mas não deve iniciar nem terminar com uma barra. Máximo de 5.000 caracteres.
created_by_id	created_by_id	integer	ID do usuário que criou o arquivo ou pasta
created_by_api_key_id	created_by_api_key_id	integer	ID da chave de API que criou o arquivo ou pasta
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	ID da Mensagem de Entrada AS2 que criou o arquivo ou a pasta
created_by_automation_id	created_by_automation_id	integer	ID da Automação que criou o arquivo ou pasta
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	ID do Registro de Pacote que criou o arquivo ou pasta
created_by_inbox_id	created_by_inbox_id	integer	ID da caixa de entrada que criou o arquivo ou pasta
created_by_remote_server_id	created_by_remote_server_id	integer	ID do Servidor Remoto que criou o arquivo ou pasta
created_by_sync_id	created_by_sync_id	integer	ID da Sincronização que criou o arquivo ou pasta
custom_metadata	custom_metadata	object	Mapa de metadados personalizado de chaves e valores. Limitado a 32 chaves, 256 caracteres por chave e 1.024 caracteres por valor.
display_name	display_name	string	Nome de exibição de arquivo ou pasta
tipo	type	string	Tipo: `directory` ou `file`.
size	size	integer	Tamanho do arquivo ou da pasta
criado_em	created_at	string	Data ou hora criada pelo arquivo
last_modified_by_id	last_modified_by_id	integer	ID do usuário que modificou o arquivo ou a pasta pela última vez
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	ID da chave de API que modificou o arquivo ou a pasta pela última vez
last_modified_by_automation_id	last_modified_by_automation_id	integer	ID da Automação que modificou o arquivo ou a pasta pela última vez
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	ID do Registro de Pacote que modificou o arquivo ou pasta pela última vez
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	ID do Servidor Remoto que modificou o arquivo ou a pasta pela última vez
last_modified_by_sync_id	last_modified_by_sync_id	integer	ID da Sincronização que modificou o arquivo ou a pasta pela última vez
Mtime	mtime	string	Data ou hora da última modificação do arquivo, de acordo com o servidor. Esse é o carimbo de data/hora da última operação de Files.com do arquivo, independentemente do carimbo de data/hora modificado enviado.
provided_mtime	provided_mtime	string	Data ou hora da última modificação do arquivo, de acordo com o cliente que o definiu. Files.com permite que clientes de área de trabalho, FTP, SFTP e WebDAV defina modificados às vezes. Isso permite que a sincronização desktop-nuvem<> preserve as modificações às vezes.
crc32	crc32	string	Soma de verificação CRC32 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
md5	md5	string	Soma de verificação MD5 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
sha1	sha1	string	Soma de verificação SHA1 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
sha256	sha256	string	Soma de verificação SHA256 do arquivo. Às vezes, isso é atrasado, portanto, se você receber uma resposta em branco, aguarde e tente novamente.
tipo_de_mime	mime_type	string	Tipo MIME. Isso é determinado pela extensão filename e não é armazenado separadamente internamente.
região	region	string	Local da região
permissões	permissions	string	Uma cadeia de caracteres curta que representa as permissões do usuário atual. Pode ser `r` (Leitura),`w` (Gravação),`d` (Exclusão), `l` (Lista) ou qualquer combinação
subfolders_locked?	subfolders_locked?	boolean	As subpastas estão bloqueadas e não podem ser modificadas?
is_locked	is_locked	boolean	Esta pasta está bloqueada e não pode ser modificada?
download_uri	download_uri	string	Link para baixar o arquivo. Fornecido apenas em resposta a uma solicitação de download.
priority_color	priority_color	string	Indicador ou cor de prioridade do arquivo ou pasta
preview_id	preview_id	integer	ID da visualização do arquivo
id	preview.id	integer	ID de visualização
status	preview.status	string	Status de visualização. Pode ser inválido, not_generated, gerando, concluído ou file_too_large
download_uri	preview.download_uri	string	Link para baixar a versão prévia
tipo	preview.type	string	Tipo de visualização. Pode ser imagem, pdf, pdf_native, vídeo ou áudio
size	preview.size	string	Tamanho da visualização

Mostrar Grupo

ID da operação:: GetGroupsId

Mostrar Grupo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID do grupo.

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do grupo
nome	name	string	Nome do grupo
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
admin_ids	admin_ids	string	Lista delimitada por vírgulas de IDs de usuário que são administradores de grupo (separadas por vírgulas)
notas	notes	string	Anotações sobre esse grupo
user_ids	user_ids	string	Lista delimitada por vírgulas de IDs de usuário que pertencem a esse grupo (separadas por vírgulas)
usernames	usernames	string	Lista delimitada por vírgulas de nomes de usuário que pertencem a esse grupo (separados por vírgulas)
ftp_permission	ftp_permission	boolean	Se for true, os usuários desse grupo poderão usar FTP para fazer logon. Isso substituirá um valor falso no nível do `ftp_permission` usuário.
sftp_permission	sftp_permission	boolean	Se for true, os usuários desse grupo poderão usar o SFTP para fazer logon. Isso substituirá um valor falso no nível do `sftp_permission` usuário.
dav_permission	dav_permission	boolean	Se for true, os usuários desse grupo poderão usar o WebDAV para fazer logon. Isso substituirá um valor falso no nível do `dav_permission` usuário.
restapi_permission	restapi_permission	boolean	Se for true, os usuários desse grupo poderão usar a API REST para fazer logon. Isso substituirá um valor falso no nível do `restapi_permission` usuário.
site_id	site_id	integer	ID do Site

Mostrar Link de Compartilhamento

ID da operação:: GetBundlesId

Mostrar Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID do pacote.

Retornos

Nome	Caminho	Tipo	Description
codificar	code	string	Código do pacote. Esse código forma a parte final da URL Pública.
color_left	color_left	string	Link da página e cor do botão
color_link	color_link	string	Cor do link da barra superior
color_text	color_text	string	Link da página e cor do botão
color_top	color_top	string	Cor da tela de fundo da barra superior
color_top_text	color_top_text	string	Cor do texto da barra superior
url	url	string	URL pública do Link de Compartilhamento
descrição	description	string	Descrição pública
expira_em	expires_at	string	Data ou hora de expiração do pacote
password_protected	password_protected	boolean	Esse pacote é protegido por senha?
permissões	permissions	string	Permissões que se aplicam a Pastas neste Link de Compartilhamento.
preview_only	preview_only	boolean
require_registration	require_registration	boolean	Mostrar uma página de registro que captura o nome e o endereço de email do downloader?
require_share_recipient	require_share_recipient	boolean	Permitir apenas o acesso aos destinatários que receberam explicitamente o compartilhamento por meio de um email enviado pela interface do usuário do Files.com?
require_logout	require_logout	boolean	Se for true, ocultaremos a caixa 'Lembrar-me' na página de registro do Pacote, exigindo que o usuário faça logoff e faça logoff sempre que visitar a página.
clickwrap_body	clickwrap_body	string	Texto legal que deve ser acordado antes de acessar o Pacote.
id	form_field_set.id	integer	ID do conjunto de campos de formulário
title	form_field_set.title	string	Título a ser exibido
form_layout	form_field_set.form_layout	array of integer	Layout do formulário
form_fields	form_field_set.form_fields	array of object	Campos de formulário associados
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer o nome
skip_email	form_field_set.skip_email	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer email
skip_company	form_field_set.skip_company	boolean	Todas as InboxRegistrations ou BundleRegistrations associadas podem ser salvas sem fornecer a empresa
in_use	form_field_set.in_use	boolean	O Conjunto de Campos de Formulário está em uso por uma caixa de entrada ativa ou pacote ou registro de caixa de entrada ou registro de pacote
skip_name	skip_name	boolean	BundleRegistrations pode ser salvo sem fornecer o nome?
skip_email	skip_email	boolean	BundleRegistrations pode ser salvo sem fornecer email?
start_access_on_date	start_access_on_date	string	Data em que o compartilhamento começará a ser acessível. Se `nil` o acesso for concedido logo após a criação.
skip_company	skip_company	boolean	Os BundleRegistrations podem ser salvos sem fornecer a empresa?
id	id	integer	ID do pacote
criado_em	created_at	string	Pacote criado em data ou hora
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	Não crie subpastas para arquivos carregados neste compartilhamento. Observação: há armadilhas de segurança sutis com a permissão de uploads anônimos de vários usuários para viver na mesma pasta. Desencorajamos fortemente o uso dessa opção, a menos que seja absolutamente necessário.
max_uses	max_uses	integer	Número máximo de vezes que o pacote pode ser acessado
nota	note	string	Nota interna do pacote
path_template	path_template	string	Modelo para criar subpastas de envio. Pode usar o nome do carregador, o endereço de email, o ip, a empresa, `strftime` as diretivas e quaisquer dados de formulário personalizados.
path_template_time_zone	path_template_time_zone	string	Fuso horário a ser usado ao renderizar carimbos de data/hora em modelos de caminho.
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	Envie o recibo de entrega para o carregador. Observação: somente para compartilhamento gravável
snapshot_id	snapshot_id	integer	ID do instantâneo que contém o conteúdo desse pacote.
id_do_usuário	user_id	integer	ID do usuário do criador do pacote
nome de usuário	username	string	Nome de usuário do criador do pacote
clickwrap_id	clickwrap_id	integer	ID do clickwrap a ser usado com esse pacote.
inbox_id	inbox_id	integer	ID da caixa de entrada associada, se disponível.
nome	watermark_attachment.name	string	Nome da imagem
uri	watermark_attachment.uri	string	URI da imagem
watermark_value	watermark_value	object	Visualizar as configurações de marca d'água aplicadas a todos os itens de pacote. Usa as mesmas chaves que Behavior.value
has_inbox	has_inbox	boolean	Esse pacote tem uma caixa de entrada associada?
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	Os uploads de pasta devem ser evitados?
Caminhos	paths	array of string	Uma lista de caminhos neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
bundlepaths	bundlepaths	array of object	Uma lista de bundlepaths neste pacote. Por motivos de desempenho, isso não é fornecido ao listar pacotes.
items	bundlepaths	object

Mostrar Notificação de Link de Compartilhamento

ID da operação:: GetBundleNotificationsId

Mostrar Notificação de Link de Compartilhamento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID de notificação do pacote.

Retornos

Nome	Caminho	Tipo	Description
bundle_id	bundle_id	integer	ID do pacote para notificar sobre
id	id	integer	ID de notificação do pacote
notify_on_registration	notify_on_registration	boolean	Dispara a notificação de pacote quando ocorre uma ação de registro para ela.
notify_on_upload	notify_on_upload	boolean	Dispara a notificação de pacote quando uma ação de upload ocorre para ela.
notify_user_id	notify_user_id	integer	A ID do usuário a ser notificada.

Mostrar Usuário

ID da operação:: GetUsersId

Mostrar Usuário

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	ID de usuário.

Retornos

Nome	Caminho	Tipo	Description
id	id	integer	ID do Usuário
nome de usuário	username	string	Nome de usuário do usuário
admin_group_ids	admin_group_ids	array of integer	Lista de IDs de grupo das quais esse usuário é um administrador
allowed_ips	allowed_ips	string	Uma lista de IPs permitidos, se aplicável. Nova linha delimitada
attachments_permission	attachments_permission	boolean	Se `true`, o usuário pode criar pacotes (também conhecidos como Links de Compartilhamento). Em vez disso, use a permissão do pacote.
api_keys_count	api_keys_count	integer	Número de chaves de API associadas a esse usuário
authenticate_until	authenticate_until	string	Data ou hora agendadas em que o usuário será desativado
authentication_method	authentication_method	string	Como esse usuário é autenticado?
avatar_url	avatar_url	string	URL que contém o avatar do usuário
Faturável	billable	boolean	Este é um registro de usuário faturável?
billing_permission	billing_permission	boolean	Permitir que esse usuário execute operações na conta, pagamentos e faturas?
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	Permitir que esse usuário ignore listas negras de IP em todo o site?
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	Isentar esse usuário das regras de ciclo de vida do usuário?
criado_em	created_at	string	Quando esse usuário foi criado
dav_permission	dav_permission	boolean	O usuário pode se conectar ao WebDAV?
desabilitado	disabled	boolean	O usuário está desabilitado? Os usuários desabilitados não podem fazer logon e não contam para fins de cobrança. Os usuários podem ser desabilitados automaticamente após um período de inatividade por meio de uma configuração do Site ou agendamento a ser desativado após uma data específica.
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	Propriedade computada que retorna true se o usuário desabilitado ou expirado ou inativo.
email	email	string	Endereço de email do usuário
filesystem_layout	filesystem_layout	string	Layout do sistema de arquivos
first_login_at	first_login_at	string	Primeira vez de logon do usuário
ftp_permission	ftp_permission	boolean	O usuário pode acessar com FTP ou FTPS?
group_ids	group_ids	string	Lista separada por vírgulas de IDs de grupo das quais esse usuário é membro
header_text	header_text	string	Texto a ser exibido para o usuário no cabeçalho da interface do usuário
linguagem	language	string	Idioma preferencial
last_login_at	last_login_at	string	Hora de logon mais recente do usuário por meio de qualquer protocolo
last_web_login_at	last_web_login_at	string	Hora de logon mais recente do usuário via Web
last_ftp_login_at	last_ftp_login_at	string	Hora de logon mais recente do usuário via FTP
last_sftp_login_at	last_sftp_login_at	string	Tempo de logon mais recente do usuário via SFTP
last_dav_login_at	last_dav_login_at	string	Hora de logon mais recente do usuário via WebDAV
last_desktop_login_at	last_desktop_login_at	string	Hora de logon mais recente do usuário por meio do aplicativo desktop
last_restapi_login_at	last_restapi_login_at	string	Tempo de logon mais recente do usuário por meio da API Rest
last_api_use_at	last_api_use_at	string	Tempo de uso mais recente da API do usuário
última_atividade_em	last_active_at	string	O tempo de atividade mais recente do usuário, que é o mais recente do logon mais recente, o uso, a habilitação ou a criação da API mais recente
last_protocol_cipher	last_protocol_cipher	string	O protocolo e a criptografia mais recentes usados
lockout_expires	lockout_expires	string	Hora no futuro em que o usuário não será mais bloqueado se aplicável
nome	name	string	Nome completo do usuário
empresa	company	string	Empresa do usuário
notas	notes	string	Quaisquer anotações internas sobre o usuário
notification_daily_send_time	notification_daily_send_time	integer	Hora do dia em que as notificações diárias devem ser enviadas. Pode estar no intervalo de 0 a 23
office_integration_enabled	office_integration_enabled	boolean	Habilitar a integração com o Office para a Web?
partner_admin	partner_admin	boolean	Esse usuário é um administrador de parceiros?
partner_id	partner_id	integer	ID do parceiro se este usuário pertencer a um Parceiro
partner_name	partner_name	string	Nome do Parceiro se este usuário pertencer a um Parceiro
password_set_at	password_set_at	string	Última vez que a senha do usuário foi definida
password_validity_days	password_validity_days	integer	Número de dias para permitir que o usuário use a mesma senha
public_keys_count	public_keys_count	integer	Número de chaves públicas associadas a esse usuário
receive_admin_alerts	receive_admin_alerts	boolean	O usuário deve receber alertas de administrador, como notificações de expiração de certificado e excessos?
require_2fa	require_2fa	string	Configuração necessária para 2FA
require_login_by	require_login_by	string	Exija que o usuário faça logon por data especificada, caso contrário, ele será desabilitado.
active_2fa	active_2fa	boolean	O 2fa está ativo para o usuário?
require_password_change	require_password_change	boolean	Uma alteração de senha é necessária no logon do próximo usuário?
password_expired	password_expired	boolean	A senha do usuário expirou?
readonly_site_admin	readonly_site_admin	boolean	O usuário tem permissão para exibir todas as configurações de site (sem cobrança) deste site?
restapi_permission	restapi_permission	boolean	Esse usuário pode acessar o aplicativo Web, o aplicativo da área de trabalho, os SDKs ou a API REST? (Todas essas ferramentas usam a API internamente, portanto, esse é um conjunto de permissões unificado.)
self_managed	self_managed	boolean	Esse usuário gerencia suas próprias credenciais ou é um usuário compartilhado ou bot?
sftp_permission	sftp_permission	boolean	O usuário pode acessar com o SFTP?
site_admin	site_admin	boolean	O usuário é um administrador para este site?
site_id	site_id	integer	ID do Site
skip_welcome_screen	skip_welcome_screen	boolean	Ignorar a página de boas-vindas na interface do usuário?
ssl_required	ssl_required	string	Configuração necessária para SSL
sso_strategy_id	sso_strategy_id	integer	ID de estratégia de SSO (Logon Único) para o usuário, se aplicável.
subscribe_to_newsletter	subscribe_to_newsletter	boolean	O usuário está inscrito no boletim informativo?
externally_managed	externally_managed	boolean	Esse usuário é gerenciado por um SsoStrategy?
tags	tags	string	Lista separada por vírgulas de Marcas para este usuário. As marcas são usadas para outros recursos, como UserLifecycleRules, que podem direcionar marcas específicas. As marcas devem conter apenas letras minúsculas, números e hifens.
fuso horário	time_zone	string	Fuso horário do usuário
type_of_2fa	type_of_2fa	string	Tipos de métodos 2FA em uso para uso programático. `sms`Serão, , `totp`, `webauthn`, `yubi`, `email`ou vários valores classificados em ordem alfabética e unidos por um sublinhado. Não especifica se o usuário tem mais de um de um determinado método.
type_of_2fa_for_display	type_of_2fa_for_display	string	Tipos de métodos 2FA em uso, formatados para exibição na interface do usuário. Diferentemente `type_of_2fa`disso, esse valor deixará claro quando um usuário tiver mais de 1 do mesmo tipo de método.
user_root	user_root	string	Pasta raiz para FTP (e, opcionalmente, SFTP se a configuração apropriada em todo o site estiver definida). Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
user_home	user_home	string	Pasta inicial para FTP ou SFTP. Observe que isso não é usado para API, Área de Trabalho ou interface da Web.
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	Número de dias restantes até que a senha expire
password_expire_at	password_expire_at	string	Datetime de expiração de senha

Mover arquivo ou pasta

ID da operação:: FileActionMove

Mover arquivo ou pasta

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Caminho	path	True	string	Caminho no qual operar.
Destino	destination	True	string	Mover o caminho de destino.

Retornos

Nome	Caminho	Tipo	Description
status	status	string	Status da operação de arquivo.
file_migration_id	file_migration_id	integer	Se o status estiver pendente, essa será a ID da Migração de Arquivos para verificar se há atualizações de status.

Definições

binário

Esse é o tipo de dados básico 'binary'.

Compartilhar via

Files.com (versão prévia)

Criando uma conexão

Padrão

Limitações

Ações

Atualizar grupo

Parâmetros

Retornos

Atualizar Link de Compartilhamento

Parâmetros

Retornos

Atualizar notificação do Link de Compartilhamento

Parâmetros

Retornos

Atualizar Usuário

Parâmetros

Retornos

Atualizar Usuário

Parâmetros

Retornos

Baixar Arquivo

Parâmetros

Retornos

Carregar Arquivo

Parâmetros

Copiar arquivo ou pasta

Parâmetros

Retornos

Criar destinatário do link de compartilhamento

Parâmetros

Retornos

Criar Grupo

Parâmetros

Retornos

Criar Link de Compartilhamento

Parâmetros

Retornos

Criar notificação do Link de Compartilhamento

Parâmetros

Retornos

Criar pasta

Parâmetros

Retornos

Criar uma nova conta de usuário para o grupo

Parâmetros

Retornos

Criar Usuário

Parâmetros

Retornos

Excluir arquivo ou pasta

Parâmetros

Excluir grupo

Parâmetros

Excluir Link de Compartilhamento

Parâmetros

Excluir Notificação de Link de Compartilhamento

Parâmetros

Excluir usuário

Parâmetros

Listar destinatários de link de compartilhamento

Parâmetros

Retornos

Listar downloads de link de compartilhamento

Parâmetros

Retornos

Listar grupos

Retornos

Listar Links de Compartilhamento

Retornos

Listar notificações de link de compartilhamento

Retornos

Listar pastas por caminho

Parâmetros

Retornos

Listar registros de link de compartilhamento

Parâmetros

Retornos

Listar usuários

Retornos