Partager via


Files.com (préversion)

Le connecteur Files.com fournit une intégration directe et hautes performances pour Files.com pour les flux de travail et les intégrations automatisés sur la plateforme d’automatisation de Microsoft.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Files.com Support
URL https://www.files.com/contact
Messagerie électronique support@files.com
Métadonnées du connecteur
Éditeur Files.com
Site web https://www.files.com/
Politique de confidentialité https://www.files.com/legal/privacy
Catégories Contenu et fichiers ;Opérations informatiques

Files.com Connecteur Power Automate

Aperçu

Le connecteur Files.com fournit une intégration directe et hautes performances à Files.com de Microsoft Power Automate et d’Azure Logic Apps. Files.com est la plateforme de partage de fichiers sécurisée et sécurisée MFT, SFTP et native cloud native qui remplace les serveurs hérités fragiles par une infrastructure sécurisée et toujours activée. Automatisez les flux de fichiers critiques dans n’importe quel cloud, protocole ou partenaire, tout en prenant en charge la collaboration humaine et en éliminant le travail manuel.

Remarque : ce connecteur fournit uniquement des actions et n’inclut pas encore de déclencheurs.

Prerequisites

Avant d’utiliser ce connecteur, vérifiez que vous disposez de : 1. Un compte Files.com valide avec une clé API. 2. Accès à Microsoft Power Automate.

Authentication

Ce connecteur utilise l’authentification par clé API. Votre clé API peut être générée dans votre compte Files.com sous :

Paramètres → clés API → Créer une clé API.

Lorsque vous configurez le connecteur, entrez votre Files.com Hôte et clé API dans les champs d’authentification.

Exemple :

Hôte : clé API de votre entreprise : abc123456789...

Toutes les demandes sont envoyées à :

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

Exemple de cas d’usage 1. Gérer les utilisateurs et les groupes Créer, mettre à jour ou désactiver des utilisateurs, attribuer des rôles et gérer les appartenances aux groupes directement via des actions Power Automate. 2. Automatisez les flux de travail de liaison de partage (bundle) Générer des liens de partage pour la remise de fichiers, ajouter des destinataires, configurer des notifications ou révoquer automatiquement l’accès. 3. Synchronisez les dossiers de liste de métadonnées de fichier, récupérez les métadonnées de fichier et appliquez une logique d’automatisation, telle que les modifications d’autorisation ou le balisage. 4. Créer des flux de travail d’approvisionnement d’utilisateurs intégrer des systèmes de gestion des ressources humaines ou des identités avec Files.com pour créer automatiquement des utilisateurs ou mettre à jour l’accès lorsque des modifications se produisent. 5. Déclenchez la distribution de documents Combiner Files.com actions avec OneDrive ou SharePoint pour distribuer ou archiver des documents en toute sécurité.

Support

Pour obtenir de l’aide technique ou des questions sur la configuration du connecteur, contactez Files.com support technique à l’adresse https://www.files.com/contact

Pour connaître les problèmes spécifiques à Power Automate, reportez-vous à la documentation du connecteur personnalisé de Microsoft.

Notice légale

Ce connecteur est fourni par Files.com. En utilisant ce connecteur, vous acceptez les Files.com conditions d’utilisation et la politique de confidentialité.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Clé API securestring La api_key de cette API Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Afficher la notification de lien de partage

Afficher la notification de lien de partage

Afficher le groupe

Afficher le groupe

Afficher le lien partager

Afficher le lien partager

Afficher l’utilisateur

Afficher l’utilisateur

Copier un fichier ou un dossier

Copier un fichier ou un dossier

Créer un compte d’utilisateur pour le groupe

Créer un compte d’utilisateur pour le groupe

Créer un destinataire de lien de partage

Créer un destinataire de lien de partage

Créer un dossier

Créer un dossier

Créer un groupe

Créer un groupe

Créer un lien de partage

Créer un lien de partage

Créer un utilisateur

Créer un utilisateur

Créer une notification de lien de partage

Créer une notification de lien de partage

Déplacer un fichier ou un dossier

Déplacer un fichier ou un dossier

Groupes de listes

Groupes de listes

Lister les téléchargements de liens de partage

Lister les téléchargements de liens de partage

Mettre à jour la notification de lien de partage

Mettre à jour la notification de lien de partage

Mettre à jour le lien de partage

Mettre à jour le lien de partage

Mettre à jour un utilisateur

Mettre à jour un utilisateur

Mettre à jour un utilisateur

Mettre à jour un utilisateur

Mise à jour d’un groupe

Mise à jour d’un groupe

Rechercher un fichier ou un dossier par chemin d’accès

Rechercher un fichier ou un dossier par chemin d’accès

Répertorier les destinataires du lien de partage

Répertorier les destinataires du lien de partage

Répertorier les dossiers par chemin d’accès

Répertorier les dossiers par chemin d’accès

Répertorier les inscriptions de liens de partage

Répertorier les inscriptions de liens de partage

Répertorier les liens de partage

Répertorier les liens de partage

Répertorier les notifications de lien de partage

Répertorier les notifications de lien de partage

Répertorier les utilisateurs

Répertorier les utilisateurs

Suppression d’un groupe

Suppression d’un groupe

Supprimer l'utilisateur

Supprimer l'utilisateur

Supprimer un fichier ou un dossier

Supprimer un fichier ou un dossier

Supprimer un lien de partage

Supprimer un lien de partage

Supprimer une notification de lien de partage

Supprimer une notification de lien de partage

Télécharger le fichier

Télécharger le fichier

Télécharger le fichier

Télécharger le fichier

Afficher la notification de lien de partage

Afficher la notification de lien de partage

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID de notification de bundle.

Retours

Nom Chemin d’accès Type Description
bundle_id
bundle_id integer

ID de bundle à notifier sur

pièce d'identité
id integer

ID de notification groupé

notify_on_registration
notify_on_registration boolean

Déclenche une notification groupée lorsqu’une action d’inscription se produit pour elle.

notify_on_upload
notify_on_upload boolean

Déclenche une notification groupée lorsqu’une action de chargement se produit pour celle-ci.

notify_user_id
notify_user_id integer

ID de l’utilisateur à notifier.

Afficher le groupe

Afficher le groupe

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID de groupe.

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID de groupe

nom
name string

Nom du groupe

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

admin_ids
admin_ids string

Liste délimitée par des virgules des ID d’utilisateur qui sont des administrateurs de groupe (séparés par des virgules)

Remarques
notes string

Remarques sur ce groupe

user_ids
user_ids string

Liste délimitée par des virgules des ID d’utilisateur appartenant à ce groupe (séparés par des virgules)

usernames
usernames string

Liste délimitée par des virgules de noms d’utilisateur appartenant à ce groupe (séparés par des virgules)

ftp_permission
ftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser FTP pour se connecter. Cela remplace une valeur false au niveau de ftp_permission l’utilisateur.

sftp_permission
sftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser SFTP pour se connecter. Cela remplace une valeur false au niveau de sftp_permission l’utilisateur.

dav_permission
dav_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser WebDAV pour se connecter. Cela remplace une valeur false au niveau de dav_permission l’utilisateur.

restapi_permission
restapi_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser l’API REST pour se connecter. Cela remplace une valeur false au niveau de restapi_permission l’utilisateur.

site_id
site_id integer

ID de site

Afficher le lien partager

Afficher le lien partager

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID d’offre groupée.

Retours

Nom Chemin d’accès Type Description
code
code string

Code groupé. Ce code constitue la partie de fin de l’URL publique.

color_left
color_left string

Lien de page et couleur du bouton

color_link
color_link string

Couleur de lien de la barre supérieure

color_text
color_text string

Lien de page et couleur du bouton

color_top
color_top string

Couleur d’arrière-plan de la barre supérieure

color_top_text
color_top_text string

Couleur de texte de la barre supérieure

URL
url string

URL publique du lien de partage

descriptif
description string

Description publique

expires_at
expires_at string

Date ou heure d’expiration du bundle

password_protected
password_protected boolean

Ce mot de passe groupé est-il protégé ?

permissions
permissions string

Autorisations qui s’appliquent aux dossiers dans ce lien de partage.

preview_only
preview_only boolean
require_registration
require_registration boolean

Afficher une page d’inscription qui capture le nom et l’adresse e-mail du téléchargeur ?

require_share_recipient
require_share_recipient boolean

Autorisez uniquement l’accès aux destinataires qui ont reçu explicitement le partage via un e-mail envoyé via l’interface utilisateur Files.com ?

require_logout
require_logout boolean

Si la valeur est true, nous masquerons la zone « Mémoriser moi » sur la page d’inscription du bundle, ce qui nécessite que l’utilisateur se déconnecte et se reconnecte chaque fois qu’il visite la page.

clickwrap_body
clickwrap_body string

Texte juridique qui doit être accepté avant d’accéder à Bundle.

pièce d'identité
form_field_set.id integer

ID du jeu de champs de formulaire

title
form_field_set.title string

Titre à afficher

form_layout
form_field_set.form_layout array of integer

Disposition du formulaire

form_fields
form_field_set.form_fields array of object

Champs de formulaire associés

items
form_field_set.form_fields object
skip_name
form_field_set.skip_name boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir de nom

skip_email
form_field_set.skip_email boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’e-mail

skip_company
form_field_set.skip_company boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’entreprise

in_use
form_field_set.in_use boolean

L’ensemble de champs de formulaire est utilisé par une boîte de réception ou un bundle ou une inscription de boîte de réception ou d’offre groupée active

skip_name
skip_name boolean

BundleRegistrations peut être enregistré sans fournir de nom ?

skip_email
skip_email boolean

BundleRegistrations peut être enregistré sans fournir d’e-mail ?

start_access_on_date
start_access_on_date string

Date à laquelle le partage commence à être accessible. Si nil l’accès est accordé juste après la création.

skip_company
skip_company boolean

BundleRegistrations peut être enregistré sans fournir d’entreprise ?

pièce d'identité
id integer

ID d’offre groupée

date_de_création
created_at string

Bundle créé à la date ou à l’heure

dont_separate_submissions_by_folder
dont_separate_submissions_by_folder boolean

Ne créez pas de sous-dossiers pour les fichiers chargés sur ce partage. Remarque : il existe des pièges de sécurité subtils avec l’autorisation des chargements anonymes de plusieurs utilisateurs dans le même dossier. Nous déconseillons fortement l’utilisation de cette option, sauf si absolument nécessaire.

max_uses
max_uses integer

Nombre maximal de fois où l’offre groupée est accessible

Note
note string

Note interne groupée

path_template
path_template string

Modèle de création de sous-dossiers de soumission. Peut utiliser le nom du chargeur, l’adresse e-mail, l’adresse ip, l’entreprise, strftime les directives et toutes les données de formulaire personnalisées.

path_template_time_zone
path_template_time_zone string

Fuseau horaire à utiliser lors du rendu des horodatages dans les modèles de chemin d’accès.

send_email_receipt_to_uploader
send_email_receipt_to_uploader boolean

Envoyez le reçu de remise au chargeur. Remarque : Pour le partage accessible en écriture uniquement

snapshot_id
snapshot_id integer

ID de l’instantané contenant le contenu de ce bundle.

identifiant_utilisateur
user_id integer

ID d’utilisateur du créateur de bundle

nom d'utilisateur
username string

Nom d’utilisateur du créateur de bundle

clickwrap_id
clickwrap_id integer

ID du clickwrap à utiliser avec ce bundle.

inbox_id
inbox_id integer

ID de la boîte de réception associée, le cas échéant.

nom
watermark_attachment.name string

Nom de l’image

URI
watermark_attachment.uri string

URI d’image

watermark_value
watermark_value object

Aperçu des paramètres de filigrane appliqués à tous les éléments groupés. Utilise les mêmes clés que Behavior.value

has_inbox
has_inbox boolean

Ce bundle a-t-il une boîte de réception associée ?

dont_allow_folders_in_uploads
dont_allow_folders_in_uploads boolean

Les chargements de dossiers doivent-ils être empêchés ?

Chemins
paths array of string

Liste des chemins d’accès dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

bundlepaths
bundlepaths array of object

Liste des bundlepaths dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

items
bundlepaths object

Afficher l’utilisateur

Afficher l’utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

Identifiant utilisateur.

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID d’utilisateur

nom d'utilisateur
username string

Nom d’utilisateur de l’utilisateur

admin_group_ids
admin_group_ids array of integer

Liste des ID de groupe dont cet utilisateur est un administrateur

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

attachments_permission
attachments_permission boolean

Si true, l’utilisateur peut créer des offres groupées (également appelées liens de partage). Utilisez plutôt l’autorisation d’offre groupée.

api_keys_count
api_keys_count integer

Nombre de clés API associées à cet utilisateur

authenticate_until
authenticate_until string

Date ou heure planifiée à laquelle l’utilisateur sera désactivé

authentication_method
authentication_method string

Comment cet utilisateur est-il authentifié ?

avatar_url
avatar_url string

URL contenant l’avatar de l’utilisateur

Facturable
billable boolean

Est-ce qu’il s’agit d’un enregistrement utilisateur facturable ?

billing_permission
billing_permission boolean

Autoriser cet utilisateur à effectuer des opérations sur le compte, les paiements et les factures ?

bypass_site_allowed_ips
bypass_site_allowed_ips boolean

Autoriser cet utilisateur à ignorer les listes noires d’adresses IP à l’échelle du site ?

bypass_user_lifecycle_rules
bypass_user_lifecycle_rules boolean

Exemptez cet utilisateur des règles de cycle de vie des utilisateurs ?

date_de_création
created_at string

Lorsque cet utilisateur a été créé

dav_permission
dav_permission boolean

L’utilisateur peut-il se connecter avec WebDAV ?

handicapé
disabled boolean

L’utilisateur est-il désactivé ? Les utilisateurs désactivés ne peuvent pas se connecter et ne sont pas comptabilisés à des fins de facturation. Les utilisateurs peuvent être désactivés automatiquement après une période d’inactivité via un paramètre de site ou une planification à désactiver après une date spécifique.

disabled_expired_or_inactive
disabled_expired_or_inactive boolean

Propriété calculée qui retourne true si l’utilisateur a désactivé ou expiré ou inactif.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur

filesystem_layout
filesystem_layout string

Disposition du système de fichiers

first_login_at
first_login_at string

Première connexion de l’utilisateur

ftp_permission
ftp_permission boolean

L’utilisateur peut-il accéder avec FTP ou FTPS ?

group_ids
group_ids string

Liste séparée par des virgules d’ID de groupe dont cet utilisateur est membre

header_text
header_text string

Texte à afficher pour l’utilisateur dans l’en-tête de l’interface utilisateur

language
language string

Langage préféré

last_login_at
last_login_at string

Heure de connexion la plus récente de l’utilisateur via n’importe quel protocole

last_web_login_at
last_web_login_at string

Heure de connexion la plus récente de l’utilisateur via le web

last_ftp_login_at
last_ftp_login_at string

Heure de connexion la plus récente de l’utilisateur via FTP

last_sftp_login_at
last_sftp_login_at string

Heure de connexion la plus récente de l’utilisateur via SFTP

last_dav_login_at
last_dav_login_at string

Heure de connexion la plus récente de l’utilisateur via WebDAV

last_desktop_login_at
last_desktop_login_at string

Heure de connexion la plus récente de l’utilisateur via l’application De bureau

last_restapi_login_at
last_restapi_login_at string

Heure de connexion la plus récente de l’utilisateur via l’API Rest

last_api_use_at
last_api_use_at string

Heure d’utilisation de l’API la plus récente de l’utilisateur

date_dernière_activité
last_active_at string

L’heure d’activité la plus récente de l’utilisateur, qui est la dernière connexion, l’utilisation, l’activation ou la création de l’API la plus récente

last_protocol_cipher
last_protocol_cipher string

Protocole et chiffrement les plus récents utilisés

lockout_expires
lockout_expires string

Heure à venir que l’utilisateur ne sera plus verrouillé s’il y a lieu

nom
name string

Nom complet de l’utilisateur

entreprise
company string

Entreprise de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

notification_daily_send_time
notification_daily_send_time integer

Heure de la journée à laquelle les notifications quotidiennes doivent être envoyées. Peut être comprise entre 0 et 23

office_integration_enabled
office_integration_enabled boolean

Activer l’intégration à Office pour le web ?

partner_admin
partner_admin boolean

Cet utilisateur est-il administrateur partenaire ?

partner_id
partner_id integer

ID de partenaire si cet utilisateur appartient à un partenaire

partner_name
partner_name string

Nom du partenaire si cet utilisateur appartient à un partenaire

password_set_at
password_set_at string

Dernière fois que le mot de passe de l’utilisateur a été défini

password_validity_days
password_validity_days integer

Nombre de jours pour permettre à l’utilisateur d’utiliser le même mot de passe

public_keys_count
public_keys_count integer

Nombre de clés publiques associées à cet utilisateur

receive_admin_alerts
receive_admin_alerts boolean

L’utilisateur doit-il recevoir des alertes d’administrateur telles que des notifications d’expiration de certificat et des dépassements ?

require_2fa
require_2fa string

Paramètre obligatoire 2FA

require_login_by
require_login_by string

Exiger que l’utilisateur se connecte à la date spécifiée dans le cas contraire, il sera désactivé.

active_2fa
active_2fa boolean

2fa est-il actif pour l’utilisateur ?

require_password_change
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

password_expired
password_expired boolean

Le mot de passe de l’utilisateur a-t-il expiré ?

readonly_site_admin
readonly_site_admin boolean

L’utilisateur est-il autorisé à afficher toutes les configurations de site (non facturation) pour ce site ?

restapi_permission
restapi_permission boolean

Cet utilisateur peut-il accéder à l’application web, à l’application de bureau, aux kits SDK ou à l’API REST ? (Tous ces outils utilisent l’API en interne. Il s’agit donc d’un jeu d’autorisations unifié.)

self_managed
self_managed boolean

Cet utilisateur gère-t-il ses propres informations d’identification ou est-il un utilisateur partagé ou bot ?

sftp_permission
sftp_permission boolean

L’utilisateur peut-il accéder à SFTP ?

site_admin
site_admin boolean

L’utilisateur est-il administrateur pour ce site ?

site_id
site_id integer

ID de site

skip_welcome_screen
skip_welcome_screen boolean

Ignorez la page d’accueil de l’interface utilisateur ?

ssl_required
ssl_required string

Paramètre ssl requis

sso_strategy_id
sso_strategy_id integer

ID de stratégie de l’authentification unique (par authentification unique) pour l’utilisateur, le cas échéant.

subscribe_to_newsletter
subscribe_to_newsletter boolean

L’utilisateur est-il abonné à la newsletter ?

externally_managed
externally_managed boolean

Cet utilisateur est-il géré par un SsoStrategy ?

tags
tags string

Liste de balises séparées par des virgules pour cet utilisateur. Les balises sont utilisées pour d’autres fonctionnalités, telles que UserLifecycleRules, qui peuvent cibler des balises spécifiques. Les balises doivent contenir uniquement des lettres minuscules, des chiffres et des traits d’union.

fuseau horaire
time_zone string

Fuseau horaire de l’utilisateur

type_of_2fa
type_of_2fa string

Type(s) des méthodes 2FA en cours d’utilisation, pour une utilisation programmatique. Sera soit sms, yubitotpwebauthn, , ou emailplusieurs valeurs triées par ordre alphabétique et jointes par un trait de soulignement. Ne spécifie pas si l’utilisateur a plusieurs méthodes données.

type_of_2fa_for_display
type_of_2fa_for_display string

Type(s) des méthodes 2FA en cours d’utilisation, mis en forme pour l’affichage dans l’interface utilisateur. Contrairement type_of_2faà cette valeur, cette valeur est claire lorsqu’un utilisateur a plus de 1 de même type de méthode.

user_root
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

user_home
user_home string

Dossier d’accueil pour FTP ou SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

days_remaining_until_password_expire
days_remaining_until_password_expire integer

Nombre de jours restants jusqu’à l’expiration du mot de passe

password_expire_at
password_expire_at string

Date d’expiration du mot de passe

Copier un fichier ou un dossier

Copier un fichier ou un dossier

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Destination
destination True string

Copiez le chemin de destination.

Retours

Nom Chemin d’accès Type Description
status
status string

État de l’opération de fichier.

file_migration_id
file_migration_id integer

Si l’état est en attente, il s’agit de l’ID de la migration de fichiers pour vérifier les mises à jour d’état.

Créer un compte d’utilisateur pour le groupe

Créer un compte d’utilisateur pour le groupe

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe
group_id True integer

ID de groupe auquel associer cet utilisateur.

Méthode d’authentification
authentication_method string

Comment cet utilisateur est-il authentifié ?

Entreprise
company string

Entreprise de l’utilisateur

Messagerie électronique
email string

E-mail de l’utilisateur.

ID de groupe
group_ids string

Liste des ID de groupe à associer à cet utilisateur. Virgule délimitée.

Nom
name string

Nom complet de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

Mot de passe
password string

Mot de passe de l’utilisateur.

Exiger la modification du mot de passe
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

Accueil de l’utilisateur
user_home string

Dossier d’accueil pour FTP/SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Racine de l’utilisateur
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Nom d’utilisateur
username True string

Nom d’utilisateur de l’utilisateur

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID d’utilisateur

nom d'utilisateur
username string

Nom d’utilisateur de l’utilisateur

admin_group_ids
admin_group_ids array of integer

Liste des ID de groupe dont cet utilisateur est un administrateur

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

attachments_permission
attachments_permission boolean

Si true, l’utilisateur peut créer des offres groupées (également appelées liens de partage). Utilisez plutôt l’autorisation d’offre groupée.

api_keys_count
api_keys_count integer

Nombre de clés API associées à cet utilisateur

authenticate_until
authenticate_until string

Date ou heure planifiée à laquelle l’utilisateur sera désactivé

authentication_method
authentication_method string

Comment cet utilisateur est-il authentifié ?

avatar_url
avatar_url string

URL contenant l’avatar de l’utilisateur

Facturable
billable boolean

Est-ce qu’il s’agit d’un enregistrement utilisateur facturable ?

billing_permission
billing_permission boolean

Autoriser cet utilisateur à effectuer des opérations sur le compte, les paiements et les factures ?

bypass_site_allowed_ips
bypass_site_allowed_ips boolean

Autoriser cet utilisateur à ignorer les listes noires d’adresses IP à l’échelle du site ?

bypass_user_lifecycle_rules
bypass_user_lifecycle_rules boolean

Exemptez cet utilisateur des règles de cycle de vie des utilisateurs ?

date_de_création
created_at string

Lorsque cet utilisateur a été créé

dav_permission
dav_permission boolean

L’utilisateur peut-il se connecter avec WebDAV ?

handicapé
disabled boolean

L’utilisateur est-il désactivé ? Les utilisateurs désactivés ne peuvent pas se connecter et ne sont pas comptabilisés à des fins de facturation. Les utilisateurs peuvent être désactivés automatiquement après une période d’inactivité via un paramètre de site ou une planification à désactiver après une date spécifique.

disabled_expired_or_inactive
disabled_expired_or_inactive boolean

Propriété calculée qui retourne true si l’utilisateur a désactivé ou expiré ou inactif.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur

filesystem_layout
filesystem_layout string

Disposition du système de fichiers

first_login_at
first_login_at string

Première connexion de l’utilisateur

ftp_permission
ftp_permission boolean

L’utilisateur peut-il accéder avec FTP ou FTPS ?

group_ids
group_ids string

Liste séparée par des virgules d’ID de groupe dont cet utilisateur est membre

header_text
header_text string

Texte à afficher pour l’utilisateur dans l’en-tête de l’interface utilisateur

language
language string

Langage préféré

last_login_at
last_login_at string

Heure de connexion la plus récente de l’utilisateur via n’importe quel protocole

last_web_login_at
last_web_login_at string

Heure de connexion la plus récente de l’utilisateur via le web

last_ftp_login_at
last_ftp_login_at string

Heure de connexion la plus récente de l’utilisateur via FTP

last_sftp_login_at
last_sftp_login_at string

Heure de connexion la plus récente de l’utilisateur via SFTP

last_dav_login_at
last_dav_login_at string

Heure de connexion la plus récente de l’utilisateur via WebDAV

last_desktop_login_at
last_desktop_login_at string

Heure de connexion la plus récente de l’utilisateur via l’application De bureau

last_restapi_login_at
last_restapi_login_at string

Heure de connexion la plus récente de l’utilisateur via l’API Rest

last_api_use_at
last_api_use_at string

Heure d’utilisation de l’API la plus récente de l’utilisateur

date_dernière_activité
last_active_at string

L’heure d’activité la plus récente de l’utilisateur, qui est la dernière connexion, l’utilisation, l’activation ou la création de l’API la plus récente

last_protocol_cipher
last_protocol_cipher string

Protocole et chiffrement les plus récents utilisés

lockout_expires
lockout_expires string

Heure à venir que l’utilisateur ne sera plus verrouillé s’il y a lieu

nom
name string

Nom complet de l’utilisateur

entreprise
company string

Entreprise de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

notification_daily_send_time
notification_daily_send_time integer

Heure de la journée à laquelle les notifications quotidiennes doivent être envoyées. Peut être comprise entre 0 et 23

office_integration_enabled
office_integration_enabled boolean

Activer l’intégration à Office pour le web ?

partner_admin
partner_admin boolean

Cet utilisateur est-il administrateur partenaire ?

partner_id
partner_id integer

ID de partenaire si cet utilisateur appartient à un partenaire

partner_name
partner_name string

Nom du partenaire si cet utilisateur appartient à un partenaire

password_set_at
password_set_at string

Dernière fois que le mot de passe de l’utilisateur a été défini

password_validity_days
password_validity_days integer

Nombre de jours pour permettre à l’utilisateur d’utiliser le même mot de passe

public_keys_count
public_keys_count integer

Nombre de clés publiques associées à cet utilisateur

receive_admin_alerts
receive_admin_alerts boolean

L’utilisateur doit-il recevoir des alertes d’administrateur telles que des notifications d’expiration de certificat et des dépassements ?

require_2fa
require_2fa string

Paramètre obligatoire 2FA

require_login_by
require_login_by string

Exiger que l’utilisateur se connecte à la date spécifiée dans le cas contraire, il sera désactivé.

active_2fa
active_2fa boolean

2fa est-il actif pour l’utilisateur ?

require_password_change
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

password_expired
password_expired boolean

Le mot de passe de l’utilisateur a-t-il expiré ?

readonly_site_admin
readonly_site_admin boolean

L’utilisateur est-il autorisé à afficher toutes les configurations de site (non facturation) pour ce site ?

restapi_permission
restapi_permission boolean

Cet utilisateur peut-il accéder à l’application web, à l’application de bureau, aux kits SDK ou à l’API REST ? (Tous ces outils utilisent l’API en interne. Il s’agit donc d’un jeu d’autorisations unifié.)

self_managed
self_managed boolean

Cet utilisateur gère-t-il ses propres informations d’identification ou est-il un utilisateur partagé ou bot ?

sftp_permission
sftp_permission boolean

L’utilisateur peut-il accéder à SFTP ?

site_admin
site_admin boolean

L’utilisateur est-il administrateur pour ce site ?

site_id
site_id integer

ID de site

skip_welcome_screen
skip_welcome_screen boolean

Ignorez la page d’accueil de l’interface utilisateur ?

ssl_required
ssl_required string

Paramètre ssl requis

sso_strategy_id
sso_strategy_id integer

ID de stratégie de l’authentification unique (par authentification unique) pour l’utilisateur, le cas échéant.

subscribe_to_newsletter
subscribe_to_newsletter boolean

L’utilisateur est-il abonné à la newsletter ?

externally_managed
externally_managed boolean

Cet utilisateur est-il géré par un SsoStrategy ?

tags
tags string

Liste de balises séparées par des virgules pour cet utilisateur. Les balises sont utilisées pour d’autres fonctionnalités, telles que UserLifecycleRules, qui peuvent cibler des balises spécifiques. Les balises doivent contenir uniquement des lettres minuscules, des chiffres et des traits d’union.

fuseau horaire
time_zone string

Fuseau horaire de l’utilisateur

type_of_2fa
type_of_2fa string

Type(s) des méthodes 2FA en cours d’utilisation, pour une utilisation programmatique. Sera soit sms, yubitotpwebauthn, , ou emailplusieurs valeurs triées par ordre alphabétique et jointes par un trait de soulignement. Ne spécifie pas si l’utilisateur a plusieurs méthodes données.

type_of_2fa_for_display
type_of_2fa_for_display string

Type(s) des méthodes 2FA en cours d’utilisation, mis en forme pour l’affichage dans l’interface utilisateur. Contrairement type_of_2faà cette valeur, cette valeur est claire lorsqu’un utilisateur a plus de 1 de même type de méthode.

user_root
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

user_home
user_home string

Dossier d’accueil pour FTP ou SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

days_remaining_until_password_expire
days_remaining_until_password_expire integer

Nombre de jours restants jusqu’à l’expiration du mot de passe

password_expire_at
password_expire_at string

Date d’expiration du mot de passe

Créer un destinataire de lien de partage

Créer un destinataire de lien de partage

Paramètres

Nom Clé Obligatoire Type Description
ID d’offre groupée
bundle_id True integer

Offre groupée à partager.

Entreprise
company string

Société de destinataire.

Nom
name string

Nom du destinataire.

Note
note string

Remarque à inclure dans l’e-mail.

Recipient
recipient True string

Adresses e-mail pour partager ce bundle avec.

Retours

Nom Chemin d’accès Type Description
entreprise
company string

Société du destinataire.

nom
name string

Nom du destinataire.

Note
note string

Note envoyée au destinataire avec le bundle.

destinataire
recipient string

Adresse e-mail du destinataire.

sent_at
sent_at string

Lorsque le bundle a été partagé avec ce destinataire.

Créer un dossier

Créer un dossier

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Retours

Nom Chemin d’accès Type Description
path
path string

Chemin d’accès au fichier ou au dossier. Cela doit être délimité par une barre oblique, mais il ne doit ni commencer ni se terminer par une barre oblique. Maximum de 5 000 caractères.

created_by_id
created_by_id integer

ID utilisateur de l’utilisateur qui a créé le fichier ou le dossier

created_by_api_key_id
created_by_api_key_id integer

ID de la clé API qui a créé le fichier ou le dossier

created_by_as2_incoming_message_id
created_by_as2_incoming_message_id integer

ID du message entrant AS2 qui a créé le fichier ou le dossier

created_by_automation_id
created_by_automation_id integer

ID de l’automatisation qui a créé le fichier ou le dossier

created_by_bundle_registration_id
created_by_bundle_registration_id integer

ID de l’inscription groupée qui a créé le fichier ou le dossier

created_by_inbox_id
created_by_inbox_id integer

ID de la boîte de réception qui a créé le fichier ou le dossier

created_by_remote_server_id
created_by_remote_server_id integer

ID du serveur distant qui a créé le fichier ou le dossier

created_by_sync_id
created_by_sync_id integer

ID de la synchronisation qui a créé le fichier ou le dossier

custom_metadata
custom_metadata object

Mappage des métadonnées personnalisées des clés et des valeurs. Limité à 32 clés, 256 caractères par clé et 1024 caractères par valeur.

display_name
display_name string

Nom d’affichage du fichier ou du dossier

type
type string

Type : directory ou file.

size
size integer

Taille du fichier ou du dossier

date_de_création
created_at string

Date ou heure de création de fichier

last_modified_by_id
last_modified_by_id integer

ID utilisateur de l’utilisateur qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_api_key_id
last_modified_by_api_key_id integer

ID de la clé API qui a modifié le dernier fichier ou dossier

last_modified_by_automation_id
last_modified_by_automation_id integer

ID de l’Automatisation qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_bundle_registration_id
last_modified_by_bundle_registration_id integer

ID de l’inscription groupée qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_remote_server_id
last_modified_by_remote_server_id integer

ID du serveur distant qui a modifié le dernier fichier ou dossier

last_modified_by_sync_id
last_modified_by_sync_id integer

ID de la synchronisation qui a modifié le dernier fichier ou dossier

Mtime
mtime string

Date ou heure de la dernière modification du fichier, en fonction du serveur. Il s’agit de l’horodatage du dernier Files.com opération du fichier, quel que soit l’horodatage modifié envoyé.

provided_mtime
provided_mtime string

Date ou heure de la dernière modification du fichier, selon le client qui l’a défini. Files.com permet aux clients de bureau, FTP, SFTP et WebDAV de définir la modification à certains moments. Cela permet à la synchronisation Desktop-Cloud<> de conserver la modification à certains moments.

crc32
crc32 string

Fichier CRC32 somme de contrôle. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

md5
md5 string

Somme de contrôle MD5 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

sha1
sha1 string

Somme de contrôle SHA1 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

sha256
sha256 string

Somme de contrôle SHA256 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

mime_type
mime_type string

Type MIME. Cela est déterminé par l’extension de nom de fichier et n’est pas stocké séparément en interne.

region
region string

Emplacement de la région

permissions
permissions string

Chaîne courte représentant les autorisations de l’utilisateur actuel. Peut être r (Lecture),w (Écriture),d (Supprimer), l (Liste) ou toute combinaison

subfolders_locked ?
subfolders_locked? boolean

Les sous-dossiers sont-ils verrouillés et ne peuvent-ils pas être modifiés ?

is_locked
is_locked boolean

Ce dossier est-il verrouillé et ne peut-il pas être modifié ?

download_uri
download_uri string

Lien pour télécharger le fichier. Fourni uniquement en réponse à une demande de téléchargement.

priority_color
priority_color string

Couleur de signet ou de priorité du fichier ou du dossier

preview_id
preview_id integer

ID d’aperçu de fichier

pièce d'identité
preview.id integer

ID d’aperçu

status
preview.status string

État d’aperçu. Peut être non valide, not_generated, générer, terminer ou file_too_large

download_uri
preview.download_uri string

Lien pour télécharger la préversion

type
preview.type string

Type d’aperçu. Peut être image, pdf, pdf_native, vidéo ou audio

size
preview.size string

Taille d’aperçu

Créer un groupe

Créer un groupe

Paramètres

Nom Clé Obligatoire Type Description
ID d’administrateur
admin_ids string

Liste des ID d’utilisateur d’administrateur de groupe. Si elle est envoyée sous forme de chaîne, doit être délimitée par des virgules.

Nom
name True string

Nom du groupe.

Remarques
notes string

Notes de groupe.

ID d’utilisateur
user_ids string

Liste des ID d’utilisateur. Si elle est envoyée sous forme de chaîne, doit être délimitée par des virgules.

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID de groupe

nom
name string

Nom du groupe

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

admin_ids
admin_ids string

Liste délimitée par des virgules des ID d’utilisateur qui sont des administrateurs de groupe (séparés par des virgules)

Remarques
notes string

Remarques sur ce groupe

user_ids
user_ids string

Liste délimitée par des virgules des ID d’utilisateur appartenant à ce groupe (séparés par des virgules)

usernames
usernames string

Liste délimitée par des virgules de noms d’utilisateur appartenant à ce groupe (séparés par des virgules)

ftp_permission
ftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser FTP pour se connecter. Cela remplace une valeur false au niveau de ftp_permission l’utilisateur.

sftp_permission
sftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser SFTP pour se connecter. Cela remplace une valeur false au niveau de sftp_permission l’utilisateur.

dav_permission
dav_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser WebDAV pour se connecter. Cela remplace une valeur false au niveau de dav_permission l’utilisateur.

restapi_permission
restapi_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser l’API REST pour se connecter. Cela remplace une valeur false au niveau de restapi_permission l’utilisateur.

site_id
site_id integer

ID de site

Créer un lien de partage

Créer un lien de partage

Paramètres

Nom Clé Obligatoire Type Description
Descriptif
description string

Description publique

Expire à
expires_at date-time

Date/heure d’expiration du bundle

Utilisations maximales
max_uses integer

Nombre maximal de fois où l’offre groupée est accessible

Note
note string

Note interne groupée

Mot de passe
password string

Mot de passe pour ce bundle.

Chemins
paths True array of string

Liste des chemins à inclure dans ce bundle.

Exiger l’inscription
require_registration boolean

Afficher une page d’inscription qui capture le nom et l’adresse e-mail du téléchargeur ?

Retours

Nom Chemin d’accès Type Description
code
code string

Code groupé. Ce code constitue la partie de fin de l’URL publique.

color_left
color_left string

Lien de page et couleur du bouton

color_link
color_link string

Couleur de lien de la barre supérieure

color_text
color_text string

Lien de page et couleur du bouton

color_top
color_top string

Couleur d’arrière-plan de la barre supérieure

color_top_text
color_top_text string

Couleur de texte de la barre supérieure

URL
url string

URL publique du lien de partage

descriptif
description string

Description publique

expires_at
expires_at string

Date ou heure d’expiration du bundle

password_protected
password_protected boolean

Ce mot de passe groupé est-il protégé ?

permissions
permissions string

Autorisations qui s’appliquent aux dossiers dans ce lien de partage.

preview_only
preview_only boolean
require_registration
require_registration boolean

Afficher une page d’inscription qui capture le nom et l’adresse e-mail du téléchargeur ?

require_share_recipient
require_share_recipient boolean

Autorisez uniquement l’accès aux destinataires qui ont reçu explicitement le partage via un e-mail envoyé via l’interface utilisateur Files.com ?

require_logout
require_logout boolean

Si la valeur est true, nous masquerons la zone « Mémoriser moi » sur la page d’inscription du bundle, ce qui nécessite que l’utilisateur se déconnecte et se reconnecte chaque fois qu’il visite la page.

clickwrap_body
clickwrap_body string

Texte juridique qui doit être accepté avant d’accéder à Bundle.

pièce d'identité
form_field_set.id integer

ID du jeu de champs de formulaire

title
form_field_set.title string

Titre à afficher

form_layout
form_field_set.form_layout array of integer

Disposition du formulaire

form_fields
form_field_set.form_fields array of object

Champs de formulaire associés

items
form_field_set.form_fields object
skip_name
form_field_set.skip_name boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir de nom

skip_email
form_field_set.skip_email boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’e-mail

skip_company
form_field_set.skip_company boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’entreprise

in_use
form_field_set.in_use boolean

L’ensemble de champs de formulaire est utilisé par une boîte de réception ou un bundle ou une inscription de boîte de réception ou d’offre groupée active

skip_name
skip_name boolean

BundleRegistrations peut être enregistré sans fournir de nom ?

skip_email
skip_email boolean

BundleRegistrations peut être enregistré sans fournir d’e-mail ?

start_access_on_date
start_access_on_date string

Date à laquelle le partage commence à être accessible. Si nil l’accès est accordé juste après la création.

skip_company
skip_company boolean

BundleRegistrations peut être enregistré sans fournir d’entreprise ?

pièce d'identité
id integer

ID d’offre groupée

date_de_création
created_at string

Bundle créé à la date ou à l’heure

dont_separate_submissions_by_folder
dont_separate_submissions_by_folder boolean

Ne créez pas de sous-dossiers pour les fichiers chargés sur ce partage. Remarque : il existe des pièges de sécurité subtils avec l’autorisation des chargements anonymes de plusieurs utilisateurs dans le même dossier. Nous déconseillons fortement l’utilisation de cette option, sauf si absolument nécessaire.

max_uses
max_uses integer

Nombre maximal de fois où l’offre groupée est accessible

Note
note string

Note interne groupée

path_template
path_template string

Modèle de création de sous-dossiers de soumission. Peut utiliser le nom du chargeur, l’adresse e-mail, l’adresse ip, l’entreprise, strftime les directives et toutes les données de formulaire personnalisées.

path_template_time_zone
path_template_time_zone string

Fuseau horaire à utiliser lors du rendu des horodatages dans les modèles de chemin d’accès.

send_email_receipt_to_uploader
send_email_receipt_to_uploader boolean

Envoyez le reçu de remise au chargeur. Remarque : Pour le partage accessible en écriture uniquement

snapshot_id
snapshot_id integer

ID de l’instantané contenant le contenu de ce bundle.

identifiant_utilisateur
user_id integer

ID d’utilisateur du créateur de bundle

nom d'utilisateur
username string

Nom d’utilisateur du créateur de bundle

clickwrap_id
clickwrap_id integer

ID du clickwrap à utiliser avec ce bundle.

inbox_id
inbox_id integer

ID de la boîte de réception associée, le cas échéant.

nom
watermark_attachment.name string

Nom de l’image

URI
watermark_attachment.uri string

URI d’image

watermark_value
watermark_value object

Aperçu des paramètres de filigrane appliqués à tous les éléments groupés. Utilise les mêmes clés que Behavior.value

has_inbox
has_inbox boolean

Ce bundle a-t-il une boîte de réception associée ?

dont_allow_folders_in_uploads
dont_allow_folders_in_uploads boolean

Les chargements de dossiers doivent-ils être empêchés ?

Chemins
paths array of string

Liste des chemins d’accès dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

bundlepaths
bundlepaths array of object

Liste des bundlepaths dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

items
bundlepaths object

Créer un utilisateur

Créer un utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Méthode d’authentification
authentication_method string

Comment cet utilisateur est-il authentifié ?

Entreprise
company string

Entreprise de l’utilisateur

Messagerie électronique
email string

E-mail de l’utilisateur.

ID de groupe
group_ids string

Liste des ID de groupe à associer à cet utilisateur. Virgule délimitée.

Nom
name string

Nom complet de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

Mot de passe
password string

Mot de passe de l’utilisateur.

Exiger la modification du mot de passe
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

Accueil de l’utilisateur
user_home string

Dossier d’accueil pour FTP/SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Racine de l’utilisateur
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Nom d’utilisateur
username True string

Nom d’utilisateur de l’utilisateur

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID d’utilisateur

nom d'utilisateur
username string

Nom d’utilisateur de l’utilisateur

admin_group_ids
admin_group_ids array of integer

Liste des ID de groupe dont cet utilisateur est un administrateur

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

attachments_permission
attachments_permission boolean

Si true, l’utilisateur peut créer des offres groupées (également appelées liens de partage). Utilisez plutôt l’autorisation d’offre groupée.

api_keys_count
api_keys_count integer

Nombre de clés API associées à cet utilisateur

authenticate_until
authenticate_until string

Date ou heure planifiée à laquelle l’utilisateur sera désactivé

authentication_method
authentication_method string

Comment cet utilisateur est-il authentifié ?

avatar_url
avatar_url string

URL contenant l’avatar de l’utilisateur

Facturable
billable boolean

Est-ce qu’il s’agit d’un enregistrement utilisateur facturable ?

billing_permission
billing_permission boolean

Autoriser cet utilisateur à effectuer des opérations sur le compte, les paiements et les factures ?

bypass_site_allowed_ips
bypass_site_allowed_ips boolean

Autoriser cet utilisateur à ignorer les listes noires d’adresses IP à l’échelle du site ?

bypass_user_lifecycle_rules
bypass_user_lifecycle_rules boolean

Exemptez cet utilisateur des règles de cycle de vie des utilisateurs ?

date_de_création
created_at string

Lorsque cet utilisateur a été créé

dav_permission
dav_permission boolean

L’utilisateur peut-il se connecter avec WebDAV ?

handicapé
disabled boolean

L’utilisateur est-il désactivé ? Les utilisateurs désactivés ne peuvent pas se connecter et ne sont pas comptabilisés à des fins de facturation. Les utilisateurs peuvent être désactivés automatiquement après une période d’inactivité via un paramètre de site ou une planification à désactiver après une date spécifique.

disabled_expired_or_inactive
disabled_expired_or_inactive boolean

Propriété calculée qui retourne true si l’utilisateur a désactivé ou expiré ou inactif.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur

filesystem_layout
filesystem_layout string

Disposition du système de fichiers

first_login_at
first_login_at string

Première connexion de l’utilisateur

ftp_permission
ftp_permission boolean

L’utilisateur peut-il accéder avec FTP ou FTPS ?

group_ids
group_ids string

Liste séparée par des virgules d’ID de groupe dont cet utilisateur est membre

header_text
header_text string

Texte à afficher pour l’utilisateur dans l’en-tête de l’interface utilisateur

language
language string

Langage préféré

last_login_at
last_login_at string

Heure de connexion la plus récente de l’utilisateur via n’importe quel protocole

last_web_login_at
last_web_login_at string

Heure de connexion la plus récente de l’utilisateur via le web

last_ftp_login_at
last_ftp_login_at string

Heure de connexion la plus récente de l’utilisateur via FTP

last_sftp_login_at
last_sftp_login_at string

Heure de connexion la plus récente de l’utilisateur via SFTP

last_dav_login_at
last_dav_login_at string

Heure de connexion la plus récente de l’utilisateur via WebDAV

last_desktop_login_at
last_desktop_login_at string

Heure de connexion la plus récente de l’utilisateur via l’application De bureau

last_restapi_login_at
last_restapi_login_at string

Heure de connexion la plus récente de l’utilisateur via l’API Rest

last_api_use_at
last_api_use_at string

Heure d’utilisation de l’API la plus récente de l’utilisateur

date_dernière_activité
last_active_at string

L’heure d’activité la plus récente de l’utilisateur, qui est la dernière connexion, l’utilisation, l’activation ou la création de l’API la plus récente

last_protocol_cipher
last_protocol_cipher string

Protocole et chiffrement les plus récents utilisés

lockout_expires
lockout_expires string

Heure à venir que l’utilisateur ne sera plus verrouillé s’il y a lieu

nom
name string

Nom complet de l’utilisateur

entreprise
company string

Entreprise de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

notification_daily_send_time
notification_daily_send_time integer

Heure de la journée à laquelle les notifications quotidiennes doivent être envoyées. Peut être comprise entre 0 et 23

office_integration_enabled
office_integration_enabled boolean

Activer l’intégration à Office pour le web ?

partner_admin
partner_admin boolean

Cet utilisateur est-il administrateur partenaire ?

partner_id
partner_id integer

ID de partenaire si cet utilisateur appartient à un partenaire

partner_name
partner_name string

Nom du partenaire si cet utilisateur appartient à un partenaire

password_set_at
password_set_at string

Dernière fois que le mot de passe de l’utilisateur a été défini

password_validity_days
password_validity_days integer

Nombre de jours pour permettre à l’utilisateur d’utiliser le même mot de passe

public_keys_count
public_keys_count integer

Nombre de clés publiques associées à cet utilisateur

receive_admin_alerts
receive_admin_alerts boolean

L’utilisateur doit-il recevoir des alertes d’administrateur telles que des notifications d’expiration de certificat et des dépassements ?

require_2fa
require_2fa string

Paramètre obligatoire 2FA

require_login_by
require_login_by string

Exiger que l’utilisateur se connecte à la date spécifiée dans le cas contraire, il sera désactivé.

active_2fa
active_2fa boolean

2fa est-il actif pour l’utilisateur ?

require_password_change
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

password_expired
password_expired boolean

Le mot de passe de l’utilisateur a-t-il expiré ?

readonly_site_admin
readonly_site_admin boolean

L’utilisateur est-il autorisé à afficher toutes les configurations de site (non facturation) pour ce site ?

restapi_permission
restapi_permission boolean

Cet utilisateur peut-il accéder à l’application web, à l’application de bureau, aux kits SDK ou à l’API REST ? (Tous ces outils utilisent l’API en interne. Il s’agit donc d’un jeu d’autorisations unifié.)

self_managed
self_managed boolean

Cet utilisateur gère-t-il ses propres informations d’identification ou est-il un utilisateur partagé ou bot ?

sftp_permission
sftp_permission boolean

L’utilisateur peut-il accéder à SFTP ?

site_admin
site_admin boolean

L’utilisateur est-il administrateur pour ce site ?

site_id
site_id integer

ID de site

skip_welcome_screen
skip_welcome_screen boolean

Ignorez la page d’accueil de l’interface utilisateur ?

ssl_required
ssl_required string

Paramètre ssl requis

sso_strategy_id
sso_strategy_id integer

ID de stratégie de l’authentification unique (par authentification unique) pour l’utilisateur, le cas échéant.

subscribe_to_newsletter
subscribe_to_newsletter boolean

L’utilisateur est-il abonné à la newsletter ?

externally_managed
externally_managed boolean

Cet utilisateur est-il géré par un SsoStrategy ?

tags
tags string

Liste de balises séparées par des virgules pour cet utilisateur. Les balises sont utilisées pour d’autres fonctionnalités, telles que UserLifecycleRules, qui peuvent cibler des balises spécifiques. Les balises doivent contenir uniquement des lettres minuscules, des chiffres et des traits d’union.

fuseau horaire
time_zone string

Fuseau horaire de l’utilisateur

type_of_2fa
type_of_2fa string

Type(s) des méthodes 2FA en cours d’utilisation, pour une utilisation programmatique. Sera soit sms, yubitotpwebauthn, , ou emailplusieurs valeurs triées par ordre alphabétique et jointes par un trait de soulignement. Ne spécifie pas si l’utilisateur a plusieurs méthodes données.

type_of_2fa_for_display
type_of_2fa_for_display string

Type(s) des méthodes 2FA en cours d’utilisation, mis en forme pour l’affichage dans l’interface utilisateur. Contrairement type_of_2faà cette valeur, cette valeur est claire lorsqu’un utilisateur a plus de 1 de même type de méthode.

user_root
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

user_home
user_home string

Dossier d’accueil pour FTP ou SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

days_remaining_until_password_expire
days_remaining_until_password_expire integer

Nombre de jours restants jusqu’à l’expiration du mot de passe

password_expire_at
password_expire_at string

Date d’expiration du mot de passe

Créer une notification de lien de partage

Créer une notification de lien de partage

Paramètres

Nom Clé Obligatoire Type Description
ID d’offre groupée
bundle_id True integer

ID de bundle à notifier sur

Notifier l’ID d’utilisateur
notify_user_id integer

ID de l’utilisateur à notifier.

Retours

Nom Chemin d’accès Type Description
bundle_id
bundle_id integer

ID de bundle à notifier sur

pièce d'identité
id integer

ID de notification groupé

notify_on_registration
notify_on_registration boolean

Déclenche une notification groupée lorsqu’une action d’inscription se produit pour elle.

notify_on_upload
notify_on_upload boolean

Déclenche une notification groupée lorsqu’une action de chargement se produit pour celle-ci.

notify_user_id
notify_user_id integer

ID de l’utilisateur à notifier.

Déplacer un fichier ou un dossier

Déplacer un fichier ou un dossier

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Destination
destination True string

Déplacer le chemin de destination.

Retours

Nom Chemin d’accès Type Description
status
status string

État de l’opération de fichier.

file_migration_id
file_migration_id integer

Si l’état est en attente, il s’agit de l’ID de la migration de fichiers pour vérifier les mises à jour d’état.

Groupes de listes

Groupes de listes

Retours

Nom Chemin d’accès Type Description
array of object
pièce d'identité
id integer

ID de groupe

nom
name string

Nom du groupe

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

admin_ids
admin_ids string

Liste délimitée par des virgules des ID d’utilisateur qui sont des administrateurs de groupe (séparés par des virgules)

Remarques
notes string

Remarques sur ce groupe

user_ids
user_ids string

Liste délimitée par des virgules des ID d’utilisateur appartenant à ce groupe (séparés par des virgules)

usernames
usernames string

Liste délimitée par des virgules de noms d’utilisateur appartenant à ce groupe (séparés par des virgules)

ftp_permission
ftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser FTP pour se connecter. Cela remplace une valeur false au niveau de ftp_permission l’utilisateur.

sftp_permission
sftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser SFTP pour se connecter. Cela remplace une valeur false au niveau de sftp_permission l’utilisateur.

dav_permission
dav_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser WebDAV pour se connecter. Cela remplace une valeur false au niveau de dav_permission l’utilisateur.

restapi_permission
restapi_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser l’API REST pour se connecter. Cela remplace une valeur false au niveau de restapi_permission l’utilisateur.

site_id
site_id integer

ID de site

Lister les téléchargements de liens de partage

Lister les téléchargements de liens de partage

Paramètres

Nom Clé Obligatoire Type Description
ID d’offre groupée
bundle_id integer

ID d’offre groupée

Retours

Nom Chemin d’accès Type Description
array of object
code
bundle_registration.code string

Code de cookie d’inscription

nom
bundle_registration.name string

Nom de l’inscription

entreprise
bundle_registration.company string

Nom de la société enregistrée

Messagerie électronique
bundle_registration.email string

Adresse e-mail de l’inscription

Ip
bundle_registration.ip string

Adresse IP de l’enregistrement

inbox_code
bundle_registration.inbox_code string

Code de cookie InboxRegistration, s’il existe un inboxRegistration associé

clickwrap_body
bundle_registration.clickwrap_body string

Texte Clickwrap affiché à l’inscription

form_field_set_id
bundle_registration.form_field_set_id integer

ID du jeu de champs de formulaire associé

form_field_data
bundle_registration.form_field_data object

Données pour le champ de formulaire défini avec des ID de champ de formulaire en tant que clés et données utilisateur en tant que valeurs

bundle_code
bundle_registration.bundle_code string

Code d’URL de bundle

bundle_id
bundle_registration.bundle_id integer

ID de l’offre groupée associée

bundle_recipient_id
bundle_registration.bundle_recipient_id integer

ID du destinataire de bundle associé

date_de_création
bundle_registration.created_at string

Date ou heure de création de l’inscription

download_method
download_method string

Méthode download (fichier ou full_zip)

path
path string

Chemin d’accès au téléchargement. Cela doit être délimité par une barre oblique, mais il ne doit ni commencer ni se terminer par une barre oblique. Maximum de 5 000 caractères.

date_de_création
created_at string

Date ou heure de téléchargement

Mettre à jour la notification de lien de partage

Mettre à jour la notification de lien de partage

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID de notification de bundle.

Notifier lors de l’inscription
notify_on_registration boolean

Déclenche une notification groupée lorsqu’une action d’inscription se produit pour elle.

Notifier lors du chargement
notify_on_upload boolean

Déclenche une notification groupée lorsqu’une action de chargement se produit pour celle-ci.

Retours

Nom Chemin d’accès Type Description
bundle_id
bundle_id integer

ID de bundle à notifier sur

pièce d'identité
id integer

ID de notification groupé

notify_on_registration
notify_on_registration boolean

Déclenche une notification groupée lorsqu’une action d’inscription se produit pour elle.

notify_on_upload
notify_on_upload boolean

Déclenche une notification groupée lorsqu’une action de chargement se produit pour celle-ci.

notify_user_id
notify_user_id integer

ID de l’utilisateur à notifier.

Mettre à jour le lien de partage

Mettre à jour le lien de partage

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID d’offre groupée.

Expire à
expires_at date-time

Date/heure d’expiration du bundle

Retours

Nom Chemin d’accès Type Description
code
code string

Code groupé. Ce code constitue la partie de fin de l’URL publique.

color_left
color_left string

Lien de page et couleur du bouton

color_link
color_link string

Couleur de lien de la barre supérieure

color_text
color_text string

Lien de page et couleur du bouton

color_top
color_top string

Couleur d’arrière-plan de la barre supérieure

color_top_text
color_top_text string

Couleur de texte de la barre supérieure

URL
url string

URL publique du lien de partage

descriptif
description string

Description publique

expires_at
expires_at string

Date ou heure d’expiration du bundle

password_protected
password_protected boolean

Ce mot de passe groupé est-il protégé ?

permissions
permissions string

Autorisations qui s’appliquent aux dossiers dans ce lien de partage.

preview_only
preview_only boolean
require_registration
require_registration boolean

Afficher une page d’inscription qui capture le nom et l’adresse e-mail du téléchargeur ?

require_share_recipient
require_share_recipient boolean

Autorisez uniquement l’accès aux destinataires qui ont reçu explicitement le partage via un e-mail envoyé via l’interface utilisateur Files.com ?

require_logout
require_logout boolean

Si la valeur est true, nous masquerons la zone « Mémoriser moi » sur la page d’inscription du bundle, ce qui nécessite que l’utilisateur se déconnecte et se reconnecte chaque fois qu’il visite la page.

clickwrap_body
clickwrap_body string

Texte juridique qui doit être accepté avant d’accéder à Bundle.

pièce d'identité
form_field_set.id integer

ID du jeu de champs de formulaire

title
form_field_set.title string

Titre à afficher

form_layout
form_field_set.form_layout array of integer

Disposition du formulaire

form_fields
form_field_set.form_fields array of object

Champs de formulaire associés

items
form_field_set.form_fields object
skip_name
form_field_set.skip_name boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir de nom

skip_email
form_field_set.skip_email boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’e-mail

skip_company
form_field_set.skip_company boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’entreprise

in_use
form_field_set.in_use boolean

L’ensemble de champs de formulaire est utilisé par une boîte de réception ou un bundle ou une inscription de boîte de réception ou d’offre groupée active

skip_name
skip_name boolean

BundleRegistrations peut être enregistré sans fournir de nom ?

skip_email
skip_email boolean

BundleRegistrations peut être enregistré sans fournir d’e-mail ?

start_access_on_date
start_access_on_date string

Date à laquelle le partage commence à être accessible. Si nil l’accès est accordé juste après la création.

skip_company
skip_company boolean

BundleRegistrations peut être enregistré sans fournir d’entreprise ?

pièce d'identité
id integer

ID d’offre groupée

date_de_création
created_at string

Bundle créé à la date ou à l’heure

dont_separate_submissions_by_folder
dont_separate_submissions_by_folder boolean

Ne créez pas de sous-dossiers pour les fichiers chargés sur ce partage. Remarque : il existe des pièges de sécurité subtils avec l’autorisation des chargements anonymes de plusieurs utilisateurs dans le même dossier. Nous déconseillons fortement l’utilisation de cette option, sauf si absolument nécessaire.

max_uses
max_uses integer

Nombre maximal de fois où l’offre groupée est accessible

Note
note string

Note interne groupée

path_template
path_template string

Modèle de création de sous-dossiers de soumission. Peut utiliser le nom du chargeur, l’adresse e-mail, l’adresse ip, l’entreprise, strftime les directives et toutes les données de formulaire personnalisées.

path_template_time_zone
path_template_time_zone string

Fuseau horaire à utiliser lors du rendu des horodatages dans les modèles de chemin d’accès.

send_email_receipt_to_uploader
send_email_receipt_to_uploader boolean

Envoyez le reçu de remise au chargeur. Remarque : Pour le partage accessible en écriture uniquement

snapshot_id
snapshot_id integer

ID de l’instantané contenant le contenu de ce bundle.

identifiant_utilisateur
user_id integer

ID d’utilisateur du créateur de bundle

nom d'utilisateur
username string

Nom d’utilisateur du créateur de bundle

clickwrap_id
clickwrap_id integer

ID du clickwrap à utiliser avec ce bundle.

inbox_id
inbox_id integer

ID de la boîte de réception associée, le cas échéant.

nom
watermark_attachment.name string

Nom de l’image

URI
watermark_attachment.uri string

URI d’image

watermark_value
watermark_value object

Aperçu des paramètres de filigrane appliqués à tous les éléments groupés. Utilise les mêmes clés que Behavior.value

has_inbox
has_inbox boolean

Ce bundle a-t-il une boîte de réception associée ?

dont_allow_folders_in_uploads
dont_allow_folders_in_uploads boolean

Les chargements de dossiers doivent-ils être empêchés ?

Chemins
paths array of string

Liste des chemins d’accès dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

bundlepaths
bundlepaths array of object

Liste des bundlepaths dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

items
bundlepaths object

Mettre à jour un utilisateur

Mettre à jour un utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Méthode d’authentification
authentication_method string

Comment cet utilisateur est-il authentifié ?

Entreprise
company string

Entreprise de l’utilisateur

Messagerie électronique
email string

E-mail de l’utilisateur.

ID de groupe
group_ids string

Liste des ID de groupe à associer à cet utilisateur. Virgule délimitée.

Nom
name string

Nom complet de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

Mot de passe
password string

Mot de passe de l’utilisateur.

Exiger la modification du mot de passe
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

Accueil de l’utilisateur
user_home string

Dossier d’accueil pour FTP/SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Racine de l’utilisateur
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Nom d’utilisateur
username string

Nom d’utilisateur de l’utilisateur

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID d’utilisateur

nom d'utilisateur
username string

Nom d’utilisateur de l’utilisateur

admin_group_ids
admin_group_ids array of integer

Liste des ID de groupe dont cet utilisateur est un administrateur

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

attachments_permission
attachments_permission boolean

Si true, l’utilisateur peut créer des offres groupées (également appelées liens de partage). Utilisez plutôt l’autorisation d’offre groupée.

api_keys_count
api_keys_count integer

Nombre de clés API associées à cet utilisateur

authenticate_until
authenticate_until string

Date ou heure planifiée à laquelle l’utilisateur sera désactivé

authentication_method
authentication_method string

Comment cet utilisateur est-il authentifié ?

avatar_url
avatar_url string

URL contenant l’avatar de l’utilisateur

Facturable
billable boolean

Est-ce qu’il s’agit d’un enregistrement utilisateur facturable ?

billing_permission
billing_permission boolean

Autoriser cet utilisateur à effectuer des opérations sur le compte, les paiements et les factures ?

bypass_site_allowed_ips
bypass_site_allowed_ips boolean

Autoriser cet utilisateur à ignorer les listes noires d’adresses IP à l’échelle du site ?

bypass_user_lifecycle_rules
bypass_user_lifecycle_rules boolean

Exemptez cet utilisateur des règles de cycle de vie des utilisateurs ?

date_de_création
created_at string

Lorsque cet utilisateur a été créé

dav_permission
dav_permission boolean

L’utilisateur peut-il se connecter avec WebDAV ?

handicapé
disabled boolean

L’utilisateur est-il désactivé ? Les utilisateurs désactivés ne peuvent pas se connecter et ne sont pas comptabilisés à des fins de facturation. Les utilisateurs peuvent être désactivés automatiquement après une période d’inactivité via un paramètre de site ou une planification à désactiver après une date spécifique.

disabled_expired_or_inactive
disabled_expired_or_inactive boolean

Propriété calculée qui retourne true si l’utilisateur a désactivé ou expiré ou inactif.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur

filesystem_layout
filesystem_layout string

Disposition du système de fichiers

first_login_at
first_login_at string

Première connexion de l’utilisateur

ftp_permission
ftp_permission boolean

L’utilisateur peut-il accéder avec FTP ou FTPS ?

group_ids
group_ids string

Liste séparée par des virgules d’ID de groupe dont cet utilisateur est membre

header_text
header_text string

Texte à afficher pour l’utilisateur dans l’en-tête de l’interface utilisateur

language
language string

Langage préféré

last_login_at
last_login_at string

Heure de connexion la plus récente de l’utilisateur via n’importe quel protocole

last_web_login_at
last_web_login_at string

Heure de connexion la plus récente de l’utilisateur via le web

last_ftp_login_at
last_ftp_login_at string

Heure de connexion la plus récente de l’utilisateur via FTP

last_sftp_login_at
last_sftp_login_at string

Heure de connexion la plus récente de l’utilisateur via SFTP

last_dav_login_at
last_dav_login_at string

Heure de connexion la plus récente de l’utilisateur via WebDAV

last_desktop_login_at
last_desktop_login_at string

Heure de connexion la plus récente de l’utilisateur via l’application De bureau

last_restapi_login_at
last_restapi_login_at string

Heure de connexion la plus récente de l’utilisateur via l’API Rest

last_api_use_at
last_api_use_at string

Heure d’utilisation de l’API la plus récente de l’utilisateur

date_dernière_activité
last_active_at string

L’heure d’activité la plus récente de l’utilisateur, qui est la dernière connexion, l’utilisation, l’activation ou la création de l’API la plus récente

last_protocol_cipher
last_protocol_cipher string

Protocole et chiffrement les plus récents utilisés

lockout_expires
lockout_expires string

Heure à venir que l’utilisateur ne sera plus verrouillé s’il y a lieu

nom
name string

Nom complet de l’utilisateur

entreprise
company string

Entreprise de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

notification_daily_send_time
notification_daily_send_time integer

Heure de la journée à laquelle les notifications quotidiennes doivent être envoyées. Peut être comprise entre 0 et 23

office_integration_enabled
office_integration_enabled boolean

Activer l’intégration à Office pour le web ?

partner_admin
partner_admin boolean

Cet utilisateur est-il administrateur partenaire ?

partner_id
partner_id integer

ID de partenaire si cet utilisateur appartient à un partenaire

partner_name
partner_name string

Nom du partenaire si cet utilisateur appartient à un partenaire

password_set_at
password_set_at string

Dernière fois que le mot de passe de l’utilisateur a été défini

password_validity_days
password_validity_days integer

Nombre de jours pour permettre à l’utilisateur d’utiliser le même mot de passe

public_keys_count
public_keys_count integer

Nombre de clés publiques associées à cet utilisateur

receive_admin_alerts
receive_admin_alerts boolean

L’utilisateur doit-il recevoir des alertes d’administrateur telles que des notifications d’expiration de certificat et des dépassements ?

require_2fa
require_2fa string

Paramètre obligatoire 2FA

require_login_by
require_login_by string

Exiger que l’utilisateur se connecte à la date spécifiée dans le cas contraire, il sera désactivé.

active_2fa
active_2fa boolean

2fa est-il actif pour l’utilisateur ?

require_password_change
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

password_expired
password_expired boolean

Le mot de passe de l’utilisateur a-t-il expiré ?

readonly_site_admin
readonly_site_admin boolean

L’utilisateur est-il autorisé à afficher toutes les configurations de site (non facturation) pour ce site ?

restapi_permission
restapi_permission boolean

Cet utilisateur peut-il accéder à l’application web, à l’application de bureau, aux kits SDK ou à l’API REST ? (Tous ces outils utilisent l’API en interne. Il s’agit donc d’un jeu d’autorisations unifié.)

self_managed
self_managed boolean

Cet utilisateur gère-t-il ses propres informations d’identification ou est-il un utilisateur partagé ou bot ?

sftp_permission
sftp_permission boolean

L’utilisateur peut-il accéder à SFTP ?

site_admin
site_admin boolean

L’utilisateur est-il administrateur pour ce site ?

site_id
site_id integer

ID de site

skip_welcome_screen
skip_welcome_screen boolean

Ignorez la page d’accueil de l’interface utilisateur ?

ssl_required
ssl_required string

Paramètre ssl requis

sso_strategy_id
sso_strategy_id integer

ID de stratégie de l’authentification unique (par authentification unique) pour l’utilisateur, le cas échéant.

subscribe_to_newsletter
subscribe_to_newsletter boolean

L’utilisateur est-il abonné à la newsletter ?

externally_managed
externally_managed boolean

Cet utilisateur est-il géré par un SsoStrategy ?

tags
tags string

Liste de balises séparées par des virgules pour cet utilisateur. Les balises sont utilisées pour d’autres fonctionnalités, telles que UserLifecycleRules, qui peuvent cibler des balises spécifiques. Les balises doivent contenir uniquement des lettres minuscules, des chiffres et des traits d’union.

fuseau horaire
time_zone string

Fuseau horaire de l’utilisateur

type_of_2fa
type_of_2fa string

Type(s) des méthodes 2FA en cours d’utilisation, pour une utilisation programmatique. Sera soit sms, yubitotpwebauthn, , ou emailplusieurs valeurs triées par ordre alphabétique et jointes par un trait de soulignement. Ne spécifie pas si l’utilisateur a plusieurs méthodes données.

type_of_2fa_for_display
type_of_2fa_for_display string

Type(s) des méthodes 2FA en cours d’utilisation, mis en forme pour l’affichage dans l’interface utilisateur. Contrairement type_of_2faà cette valeur, cette valeur est claire lorsqu’un utilisateur a plus de 1 de même type de méthode.

user_root
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

user_home
user_home string

Dossier d’accueil pour FTP ou SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

days_remaining_until_password_expire
days_remaining_until_password_expire integer

Nombre de jours restants jusqu’à l’expiration du mot de passe

password_expire_at
password_expire_at string

Date d’expiration du mot de passe

Mettre à jour un utilisateur

Mettre à jour un utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

Identifiant utilisateur.

Méthode d’authentification
authentication_method string

Comment cet utilisateur est-il authentifié ?

Entreprise
company string

Entreprise de l’utilisateur

Messagerie électronique
email string

E-mail de l’utilisateur.

ID de groupe
group_ids string

Liste des ID de groupe à associer à cet utilisateur. Virgule délimitée.

Nom
name string

Nom complet de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

Mot de passe
password string

Mot de passe de l’utilisateur.

Exiger la modification du mot de passe
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

Accueil de l’utilisateur
user_home string

Dossier d’accueil pour FTP/SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Racine de l’utilisateur
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

Nom d’utilisateur
username string

Nom d’utilisateur de l’utilisateur

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID d’utilisateur

nom d'utilisateur
username string

Nom d’utilisateur de l’utilisateur

admin_group_ids
admin_group_ids array of integer

Liste des ID de groupe dont cet utilisateur est un administrateur

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

attachments_permission
attachments_permission boolean

Si true, l’utilisateur peut créer des offres groupées (également appelées liens de partage). Utilisez plutôt l’autorisation d’offre groupée.

api_keys_count
api_keys_count integer

Nombre de clés API associées à cet utilisateur

authenticate_until
authenticate_until string

Date ou heure planifiée à laquelle l’utilisateur sera désactivé

authentication_method
authentication_method string

Comment cet utilisateur est-il authentifié ?

avatar_url
avatar_url string

URL contenant l’avatar de l’utilisateur

Facturable
billable boolean

Est-ce qu’il s’agit d’un enregistrement utilisateur facturable ?

billing_permission
billing_permission boolean

Autoriser cet utilisateur à effectuer des opérations sur le compte, les paiements et les factures ?

bypass_site_allowed_ips
bypass_site_allowed_ips boolean

Autoriser cet utilisateur à ignorer les listes noires d’adresses IP à l’échelle du site ?

bypass_user_lifecycle_rules
bypass_user_lifecycle_rules boolean

Exemptez cet utilisateur des règles de cycle de vie des utilisateurs ?

date_de_création
created_at string

Lorsque cet utilisateur a été créé

dav_permission
dav_permission boolean

L’utilisateur peut-il se connecter avec WebDAV ?

handicapé
disabled boolean

L’utilisateur est-il désactivé ? Les utilisateurs désactivés ne peuvent pas se connecter et ne sont pas comptabilisés à des fins de facturation. Les utilisateurs peuvent être désactivés automatiquement après une période d’inactivité via un paramètre de site ou une planification à désactiver après une date spécifique.

disabled_expired_or_inactive
disabled_expired_or_inactive boolean

Propriété calculée qui retourne true si l’utilisateur a désactivé ou expiré ou inactif.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur

filesystem_layout
filesystem_layout string

Disposition du système de fichiers

first_login_at
first_login_at string

Première connexion de l’utilisateur

ftp_permission
ftp_permission boolean

L’utilisateur peut-il accéder avec FTP ou FTPS ?

group_ids
group_ids string

Liste séparée par des virgules d’ID de groupe dont cet utilisateur est membre

header_text
header_text string

Texte à afficher pour l’utilisateur dans l’en-tête de l’interface utilisateur

language
language string

Langage préféré

last_login_at
last_login_at string

Heure de connexion la plus récente de l’utilisateur via n’importe quel protocole

last_web_login_at
last_web_login_at string

Heure de connexion la plus récente de l’utilisateur via le web

last_ftp_login_at
last_ftp_login_at string

Heure de connexion la plus récente de l’utilisateur via FTP

last_sftp_login_at
last_sftp_login_at string

Heure de connexion la plus récente de l’utilisateur via SFTP

last_dav_login_at
last_dav_login_at string

Heure de connexion la plus récente de l’utilisateur via WebDAV

last_desktop_login_at
last_desktop_login_at string

Heure de connexion la plus récente de l’utilisateur via l’application De bureau

last_restapi_login_at
last_restapi_login_at string

Heure de connexion la plus récente de l’utilisateur via l’API Rest

last_api_use_at
last_api_use_at string

Heure d’utilisation de l’API la plus récente de l’utilisateur

date_dernière_activité
last_active_at string

L’heure d’activité la plus récente de l’utilisateur, qui est la dernière connexion, l’utilisation, l’activation ou la création de l’API la plus récente

last_protocol_cipher
last_protocol_cipher string

Protocole et chiffrement les plus récents utilisés

lockout_expires
lockout_expires string

Heure à venir que l’utilisateur ne sera plus verrouillé s’il y a lieu

nom
name string

Nom complet de l’utilisateur

entreprise
company string

Entreprise de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

notification_daily_send_time
notification_daily_send_time integer

Heure de la journée à laquelle les notifications quotidiennes doivent être envoyées. Peut être comprise entre 0 et 23

office_integration_enabled
office_integration_enabled boolean

Activer l’intégration à Office pour le web ?

partner_admin
partner_admin boolean

Cet utilisateur est-il administrateur partenaire ?

partner_id
partner_id integer

ID de partenaire si cet utilisateur appartient à un partenaire

partner_name
partner_name string

Nom du partenaire si cet utilisateur appartient à un partenaire

password_set_at
password_set_at string

Dernière fois que le mot de passe de l’utilisateur a été défini

password_validity_days
password_validity_days integer

Nombre de jours pour permettre à l’utilisateur d’utiliser le même mot de passe

public_keys_count
public_keys_count integer

Nombre de clés publiques associées à cet utilisateur

receive_admin_alerts
receive_admin_alerts boolean

L’utilisateur doit-il recevoir des alertes d’administrateur telles que des notifications d’expiration de certificat et des dépassements ?

require_2fa
require_2fa string

Paramètre obligatoire 2FA

require_login_by
require_login_by string

Exiger que l’utilisateur se connecte à la date spécifiée dans le cas contraire, il sera désactivé.

active_2fa
active_2fa boolean

2fa est-il actif pour l’utilisateur ?

require_password_change
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

password_expired
password_expired boolean

Le mot de passe de l’utilisateur a-t-il expiré ?

readonly_site_admin
readonly_site_admin boolean

L’utilisateur est-il autorisé à afficher toutes les configurations de site (non facturation) pour ce site ?

restapi_permission
restapi_permission boolean

Cet utilisateur peut-il accéder à l’application web, à l’application de bureau, aux kits SDK ou à l’API REST ? (Tous ces outils utilisent l’API en interne. Il s’agit donc d’un jeu d’autorisations unifié.)

self_managed
self_managed boolean

Cet utilisateur gère-t-il ses propres informations d’identification ou est-il un utilisateur partagé ou bot ?

sftp_permission
sftp_permission boolean

L’utilisateur peut-il accéder à SFTP ?

site_admin
site_admin boolean

L’utilisateur est-il administrateur pour ce site ?

site_id
site_id integer

ID de site

skip_welcome_screen
skip_welcome_screen boolean

Ignorez la page d’accueil de l’interface utilisateur ?

ssl_required
ssl_required string

Paramètre ssl requis

sso_strategy_id
sso_strategy_id integer

ID de stratégie de l’authentification unique (par authentification unique) pour l’utilisateur, le cas échéant.

subscribe_to_newsletter
subscribe_to_newsletter boolean

L’utilisateur est-il abonné à la newsletter ?

externally_managed
externally_managed boolean

Cet utilisateur est-il géré par un SsoStrategy ?

tags
tags string

Liste de balises séparées par des virgules pour cet utilisateur. Les balises sont utilisées pour d’autres fonctionnalités, telles que UserLifecycleRules, qui peuvent cibler des balises spécifiques. Les balises doivent contenir uniquement des lettres minuscules, des chiffres et des traits d’union.

fuseau horaire
time_zone string

Fuseau horaire de l’utilisateur

type_of_2fa
type_of_2fa string

Type(s) des méthodes 2FA en cours d’utilisation, pour une utilisation programmatique. Sera soit sms, yubitotpwebauthn, , ou emailplusieurs valeurs triées par ordre alphabétique et jointes par un trait de soulignement. Ne spécifie pas si l’utilisateur a plusieurs méthodes données.

type_of_2fa_for_display
type_of_2fa_for_display string

Type(s) des méthodes 2FA en cours d’utilisation, mis en forme pour l’affichage dans l’interface utilisateur. Contrairement type_of_2faà cette valeur, cette valeur est claire lorsqu’un utilisateur a plus de 1 de même type de méthode.

user_root
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

user_home
user_home string

Dossier d’accueil pour FTP ou SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

days_remaining_until_password_expire
days_remaining_until_password_expire integer

Nombre de jours restants jusqu’à l’expiration du mot de passe

password_expire_at
password_expire_at string

Date d’expiration du mot de passe

Mise à jour d’un groupe

Mise à jour d’un groupe

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID de groupe.

ID d’administrateur
admin_ids string

Liste des ID d’utilisateur d’administrateur de groupe. Si elle est envoyée sous forme de chaîne, doit être délimitée par des virgules.

Nom
name string

Nom du groupe.

Remarques
notes string

Notes de groupe.

ID d’utilisateur
user_ids string

Liste des ID d’utilisateur. Si elle est envoyée sous forme de chaîne, doit être délimitée par des virgules.

Retours

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID de groupe

nom
name string

Nom du groupe

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

admin_ids
admin_ids string

Liste délimitée par des virgules des ID d’utilisateur qui sont des administrateurs de groupe (séparés par des virgules)

Remarques
notes string

Remarques sur ce groupe

user_ids
user_ids string

Liste délimitée par des virgules des ID d’utilisateur appartenant à ce groupe (séparés par des virgules)

usernames
usernames string

Liste délimitée par des virgules de noms d’utilisateur appartenant à ce groupe (séparés par des virgules)

ftp_permission
ftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser FTP pour se connecter. Cela remplace une valeur false au niveau de ftp_permission l’utilisateur.

sftp_permission
sftp_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser SFTP pour se connecter. Cela remplace une valeur false au niveau de sftp_permission l’utilisateur.

dav_permission
dav_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser WebDAV pour se connecter. Cela remplace une valeur false au niveau de dav_permission l’utilisateur.

restapi_permission
restapi_permission boolean

Si la valeur est true, les utilisateurs de ce groupe peuvent utiliser l’API REST pour se connecter. Cela remplace une valeur false au niveau de restapi_permission l’utilisateur.

site_id
site_id integer

ID de site

Rechercher un fichier ou un dossier par chemin d’accès

Rechercher un fichier ou un dossier par chemin d’accès

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Retours

Nom Chemin d’accès Type Description
path
path string

Chemin d’accès au fichier ou au dossier. Cela doit être délimité par une barre oblique, mais il ne doit ni commencer ni se terminer par une barre oblique. Maximum de 5 000 caractères.

created_by_id
created_by_id integer

ID utilisateur de l’utilisateur qui a créé le fichier ou le dossier

created_by_api_key_id
created_by_api_key_id integer

ID de la clé API qui a créé le fichier ou le dossier

created_by_as2_incoming_message_id
created_by_as2_incoming_message_id integer

ID du message entrant AS2 qui a créé le fichier ou le dossier

created_by_automation_id
created_by_automation_id integer

ID de l’automatisation qui a créé le fichier ou le dossier

created_by_bundle_registration_id
created_by_bundle_registration_id integer

ID de l’inscription groupée qui a créé le fichier ou le dossier

created_by_inbox_id
created_by_inbox_id integer

ID de la boîte de réception qui a créé le fichier ou le dossier

created_by_remote_server_id
created_by_remote_server_id integer

ID du serveur distant qui a créé le fichier ou le dossier

created_by_sync_id
created_by_sync_id integer

ID de la synchronisation qui a créé le fichier ou le dossier

custom_metadata
custom_metadata object

Mappage des métadonnées personnalisées des clés et des valeurs. Limité à 32 clés, 256 caractères par clé et 1024 caractères par valeur.

display_name
display_name string

Nom d’affichage du fichier ou du dossier

type
type string

Type : directory ou file.

size
size integer

Taille du fichier ou du dossier

date_de_création
created_at string

Date ou heure de création de fichier

last_modified_by_id
last_modified_by_id integer

ID utilisateur de l’utilisateur qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_api_key_id
last_modified_by_api_key_id integer

ID de la clé API qui a modifié le dernier fichier ou dossier

last_modified_by_automation_id
last_modified_by_automation_id integer

ID de l’Automatisation qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_bundle_registration_id
last_modified_by_bundle_registration_id integer

ID de l’inscription groupée qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_remote_server_id
last_modified_by_remote_server_id integer

ID du serveur distant qui a modifié le dernier fichier ou dossier

last_modified_by_sync_id
last_modified_by_sync_id integer

ID de la synchronisation qui a modifié le dernier fichier ou dossier

Mtime
mtime string

Date ou heure de la dernière modification du fichier, en fonction du serveur. Il s’agit de l’horodatage du dernier Files.com opération du fichier, quel que soit l’horodatage modifié envoyé.

provided_mtime
provided_mtime string

Date ou heure de la dernière modification du fichier, selon le client qui l’a défini. Files.com permet aux clients de bureau, FTP, SFTP et WebDAV de définir la modification à certains moments. Cela permet à la synchronisation Desktop-Cloud<> de conserver la modification à certains moments.

crc32
crc32 string

Fichier CRC32 somme de contrôle. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

md5
md5 string

Somme de contrôle MD5 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

sha1
sha1 string

Somme de contrôle SHA1 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

sha256
sha256 string

Somme de contrôle SHA256 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

mime_type
mime_type string

Type MIME. Cela est déterminé par l’extension de nom de fichier et n’est pas stocké séparément en interne.

region
region string

Emplacement de la région

permissions
permissions string

Chaîne courte représentant les autorisations de l’utilisateur actuel. Peut être r (Lecture),w (Écriture),d (Supprimer), l (Liste) ou toute combinaison

subfolders_locked ?
subfolders_locked? boolean

Les sous-dossiers sont-ils verrouillés et ne peuvent-ils pas être modifiés ?

is_locked
is_locked boolean

Ce dossier est-il verrouillé et ne peut-il pas être modifié ?

download_uri
download_uri string

Lien pour télécharger le fichier. Fourni uniquement en réponse à une demande de téléchargement.

priority_color
priority_color string

Couleur de signet ou de priorité du fichier ou du dossier

preview_id
preview_id integer

ID d’aperçu de fichier

pièce d'identité
preview.id integer

ID d’aperçu

status
preview.status string

État d’aperçu. Peut être non valide, not_generated, générer, terminer ou file_too_large

download_uri
preview.download_uri string

Lien pour télécharger la préversion

type
preview.type string

Type d’aperçu. Peut être image, pdf, pdf_native, vidéo ou audio

size
preview.size string

Taille d’aperçu

Répertorier les destinataires du lien de partage

Répertorier les destinataires du lien de partage

Paramètres

Nom Clé Obligatoire Type Description
ID d’offre groupée
bundle_id True integer

Répertorier les destinataires de l’offre groupée avec cet ID.

Retours

Nom Chemin d’accès Type Description
array of object
entreprise
company string

Société du destinataire.

nom
name string

Nom du destinataire.

Note
note string

Note envoyée au destinataire avec le bundle.

destinataire
recipient string

Adresse e-mail du destinataire.

sent_at
sent_at string

Lorsque le bundle a été partagé avec ce destinataire.

Répertorier les dossiers par chemin d’accès

Répertorier les dossiers par chemin d’accès

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Retours

Nom Chemin d’accès Type Description
array of object
path
path string

Chemin d’accès au fichier ou au dossier. Cela doit être délimité par une barre oblique, mais il ne doit ni commencer ni se terminer par une barre oblique. Maximum de 5 000 caractères.

created_by_id
created_by_id integer

ID utilisateur de l’utilisateur qui a créé le fichier ou le dossier

created_by_api_key_id
created_by_api_key_id integer

ID de la clé API qui a créé le fichier ou le dossier

created_by_as2_incoming_message_id
created_by_as2_incoming_message_id integer

ID du message entrant AS2 qui a créé le fichier ou le dossier

created_by_automation_id
created_by_automation_id integer

ID de l’automatisation qui a créé le fichier ou le dossier

created_by_bundle_registration_id
created_by_bundle_registration_id integer

ID de l’inscription groupée qui a créé le fichier ou le dossier

created_by_inbox_id
created_by_inbox_id integer

ID de la boîte de réception qui a créé le fichier ou le dossier

created_by_remote_server_id
created_by_remote_server_id integer

ID du serveur distant qui a créé le fichier ou le dossier

created_by_sync_id
created_by_sync_id integer

ID de la synchronisation qui a créé le fichier ou le dossier

custom_metadata
custom_metadata object

Mappage des métadonnées personnalisées des clés et des valeurs. Limité à 32 clés, 256 caractères par clé et 1024 caractères par valeur.

display_name
display_name string

Nom d’affichage du fichier ou du dossier

type
type string

Type : directory ou file.

size
size integer

Taille du fichier ou du dossier

date_de_création
created_at string

Date ou heure de création de fichier

last_modified_by_id
last_modified_by_id integer

ID utilisateur de l’utilisateur qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_api_key_id
last_modified_by_api_key_id integer

ID de la clé API qui a modifié le dernier fichier ou dossier

last_modified_by_automation_id
last_modified_by_automation_id integer

ID de l’Automatisation qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_bundle_registration_id
last_modified_by_bundle_registration_id integer

ID de l’inscription groupée qui a modifié le fichier ou le dossier pour la dernière fois

last_modified_by_remote_server_id
last_modified_by_remote_server_id integer

ID du serveur distant qui a modifié le dernier fichier ou dossier

last_modified_by_sync_id
last_modified_by_sync_id integer

ID de la synchronisation qui a modifié le dernier fichier ou dossier

Mtime
mtime string

Date ou heure de la dernière modification du fichier, en fonction du serveur. Il s’agit de l’horodatage du dernier Files.com opération du fichier, quel que soit l’horodatage modifié envoyé.

provided_mtime
provided_mtime string

Date ou heure de la dernière modification du fichier, selon le client qui l’a défini. Files.com permet aux clients de bureau, FTP, SFTP et WebDAV de définir la modification à certains moments. Cela permet à la synchronisation Desktop-Cloud<> de conserver la modification à certains moments.

crc32
crc32 string

Fichier CRC32 somme de contrôle. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

md5
md5 string

Somme de contrôle MD5 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

sha1
sha1 string

Somme de contrôle SHA1 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

sha256
sha256 string

Somme de contrôle SHA256 du fichier. Cela est parfois retardé. Par conséquent, si vous obtenez une réponse vide, attendez et réessayez.

mime_type
mime_type string

Type MIME. Cela est déterminé par l’extension de nom de fichier et n’est pas stocké séparément en interne.

region
region string

Emplacement de la région

permissions
permissions string

Chaîne courte représentant les autorisations de l’utilisateur actuel. Peut être r (Lecture),w (Écriture),d (Supprimer), l (Liste) ou toute combinaison

subfolders_locked ?
subfolders_locked? boolean

Les sous-dossiers sont-ils verrouillés et ne peuvent-ils pas être modifiés ?

is_locked
is_locked boolean

Ce dossier est-il verrouillé et ne peut-il pas être modifié ?

download_uri
download_uri string

Lien pour télécharger le fichier. Fourni uniquement en réponse à une demande de téléchargement.

priority_color
priority_color string

Couleur de signet ou de priorité du fichier ou du dossier

preview_id
preview_id integer

ID d’aperçu de fichier

pièce d'identité
preview.id integer

ID d’aperçu

status
preview.status string

État d’aperçu. Peut être non valide, not_generated, générer, terminer ou file_too_large

download_uri
preview.download_uri string

Lien pour télécharger la préversion

type
preview.type string

Type d’aperçu. Peut être image, pdf, pdf_native, vidéo ou audio

size
preview.size string

Taille d’aperçu

Répertorier les inscriptions de liens de partage

Répertorier les inscriptions de liens de partage

Paramètres

Nom Clé Obligatoire Type Description
ID d’offre groupée
bundle_id integer

ID du bundle associé

Retours

Nom Chemin d’accès Type Description
array of object
code
code string

Code de cookie d’inscription

nom
name string

Nom de l’inscription

entreprise
company string

Nom de la société enregistrée

Messagerie électronique
email string

Adresse e-mail de l’inscription

Ip
ip string

Adresse IP de l’enregistrement

inbox_code
inbox_code string

Code de cookie InboxRegistration, s’il existe un inboxRegistration associé

clickwrap_body
clickwrap_body string

Texte Clickwrap affiché à l’inscription

form_field_set_id
form_field_set_id integer

ID du jeu de champs de formulaire associé

form_field_data
form_field_data object

Données pour le champ de formulaire défini avec des ID de champ de formulaire en tant que clés et données utilisateur en tant que valeurs

bundle_code
bundle_code string

Code d’URL de bundle

bundle_id
bundle_id integer

ID de l’offre groupée associée

bundle_recipient_id
bundle_recipient_id integer

ID du destinataire de bundle associé

date_de_création
created_at string

Date ou heure de création de l’inscription

Répertorier les liens de partage

Répertorier les liens de partage

Retours

Nom Chemin d’accès Type Description
array of object
code
code string

Code groupé. Ce code constitue la partie de fin de l’URL publique.

color_left
color_left string

Lien de page et couleur du bouton

color_link
color_link string

Couleur de lien de la barre supérieure

color_text
color_text string

Lien de page et couleur du bouton

color_top
color_top string

Couleur d’arrière-plan de la barre supérieure

color_top_text
color_top_text string

Couleur de texte de la barre supérieure

URL
url string

URL publique du lien de partage

descriptif
description string

Description publique

expires_at
expires_at string

Date ou heure d’expiration du bundle

password_protected
password_protected boolean

Ce mot de passe groupé est-il protégé ?

permissions
permissions string

Autorisations qui s’appliquent aux dossiers dans ce lien de partage.

preview_only
preview_only boolean
require_registration
require_registration boolean

Afficher une page d’inscription qui capture le nom et l’adresse e-mail du téléchargeur ?

require_share_recipient
require_share_recipient boolean

Autorisez uniquement l’accès aux destinataires qui ont reçu explicitement le partage via un e-mail envoyé via l’interface utilisateur Files.com ?

require_logout
require_logout boolean

Si la valeur est true, nous masquerons la zone « Mémoriser moi » sur la page d’inscription du bundle, ce qui nécessite que l’utilisateur se déconnecte et se reconnecte chaque fois qu’il visite la page.

clickwrap_body
clickwrap_body string

Texte juridique qui doit être accepté avant d’accéder à Bundle.

pièce d'identité
form_field_set.id integer

ID du jeu de champs de formulaire

title
form_field_set.title string

Titre à afficher

form_layout
form_field_set.form_layout array of integer

Disposition du formulaire

form_fields
form_field_set.form_fields array of object

Champs de formulaire associés

items
form_field_set.form_fields object
skip_name
form_field_set.skip_name boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir de nom

skip_email
form_field_set.skip_email boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’e-mail

skip_company
form_field_set.skip_company boolean

Tous les inboxRegistrations ou BundleRegistrations associés peuvent être enregistrés sans fournir d’entreprise

in_use
form_field_set.in_use boolean

L’ensemble de champs de formulaire est utilisé par une boîte de réception ou un bundle ou une inscription de boîte de réception ou d’offre groupée active

skip_name
skip_name boolean

BundleRegistrations peut être enregistré sans fournir de nom ?

skip_email
skip_email boolean

BundleRegistrations peut être enregistré sans fournir d’e-mail ?

start_access_on_date
start_access_on_date string

Date à laquelle le partage commence à être accessible. Si nil l’accès est accordé juste après la création.

skip_company
skip_company boolean

BundleRegistrations peut être enregistré sans fournir d’entreprise ?

pièce d'identité
id integer

ID d’offre groupée

date_de_création
created_at string

Bundle créé à la date ou à l’heure

dont_separate_submissions_by_folder
dont_separate_submissions_by_folder boolean

Ne créez pas de sous-dossiers pour les fichiers chargés sur ce partage. Remarque : il existe des pièges de sécurité subtils avec l’autorisation des chargements anonymes de plusieurs utilisateurs dans le même dossier. Nous déconseillons fortement l’utilisation de cette option, sauf si absolument nécessaire.

max_uses
max_uses integer

Nombre maximal de fois où l’offre groupée est accessible

Note
note string

Note interne groupée

path_template
path_template string

Modèle de création de sous-dossiers de soumission. Peut utiliser le nom du chargeur, l’adresse e-mail, l’adresse ip, l’entreprise, strftime les directives et toutes les données de formulaire personnalisées.

path_template_time_zone
path_template_time_zone string

Fuseau horaire à utiliser lors du rendu des horodatages dans les modèles de chemin d’accès.

send_email_receipt_to_uploader
send_email_receipt_to_uploader boolean

Envoyez le reçu de remise au chargeur. Remarque : Pour le partage accessible en écriture uniquement

snapshot_id
snapshot_id integer

ID de l’instantané contenant le contenu de ce bundle.

identifiant_utilisateur
user_id integer

ID d’utilisateur du créateur de bundle

nom d'utilisateur
username string

Nom d’utilisateur du créateur de bundle

clickwrap_id
clickwrap_id integer

ID du clickwrap à utiliser avec ce bundle.

inbox_id
inbox_id integer

ID de la boîte de réception associée, le cas échéant.

nom
watermark_attachment.name string

Nom de l’image

URI
watermark_attachment.uri string

URI d’image

watermark_value
watermark_value object

Aperçu des paramètres de filigrane appliqués à tous les éléments groupés. Utilise les mêmes clés que Behavior.value

has_inbox
has_inbox boolean

Ce bundle a-t-il une boîte de réception associée ?

dont_allow_folders_in_uploads
dont_allow_folders_in_uploads boolean

Les chargements de dossiers doivent-ils être empêchés ?

Chemins
paths array of string

Liste des chemins d’accès dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

bundlepaths
bundlepaths array of object

Liste des bundlepaths dans ce bundle. Pour des raisons de performances, cela n’est pas fourni lors de la liste des offres groupées.

items
bundlepaths object

Répertorier les notifications de lien de partage

Répertorier les notifications de lien de partage

Retours

Nom Chemin d’accès Type Description
array of object
bundle_id
bundle_id integer

ID de bundle à notifier sur

pièce d'identité
id integer

ID de notification groupé

notify_on_registration
notify_on_registration boolean

Déclenche une notification groupée lorsqu’une action d’inscription se produit pour elle.

notify_on_upload
notify_on_upload boolean

Déclenche une notification groupée lorsqu’une action de chargement se produit pour celle-ci.

notify_user_id
notify_user_id integer

ID de l’utilisateur à notifier.

Répertorier les utilisateurs

Répertorier les utilisateurs

Retours

Nom Chemin d’accès Type Description
array of object
pièce d'identité
id integer

ID d’utilisateur

nom d'utilisateur
username string

Nom d’utilisateur de l’utilisateur

admin_group_ids
admin_group_ids array of integer

Liste des ID de groupe dont cet utilisateur est un administrateur

allowed_ips
allowed_ips string

Liste des adresses IP autorisées le cas échéant. Ligne délimitée

attachments_permission
attachments_permission boolean

Si true, l’utilisateur peut créer des offres groupées (également appelées liens de partage). Utilisez plutôt l’autorisation d’offre groupée.

api_keys_count
api_keys_count integer

Nombre de clés API associées à cet utilisateur

authenticate_until
authenticate_until string

Date ou heure planifiée à laquelle l’utilisateur sera désactivé

authentication_method
authentication_method string

Comment cet utilisateur est-il authentifié ?

avatar_url
avatar_url string

URL contenant l’avatar de l’utilisateur

Facturable
billable boolean

Est-ce qu’il s’agit d’un enregistrement utilisateur facturable ?

billing_permission
billing_permission boolean

Autoriser cet utilisateur à effectuer des opérations sur le compte, les paiements et les factures ?

bypass_site_allowed_ips
bypass_site_allowed_ips boolean

Autoriser cet utilisateur à ignorer les listes noires d’adresses IP à l’échelle du site ?

bypass_user_lifecycle_rules
bypass_user_lifecycle_rules boolean

Exemptez cet utilisateur des règles de cycle de vie des utilisateurs ?

date_de_création
created_at string

Lorsque cet utilisateur a été créé

dav_permission
dav_permission boolean

L’utilisateur peut-il se connecter avec WebDAV ?

handicapé
disabled boolean

L’utilisateur est-il désactivé ? Les utilisateurs désactivés ne peuvent pas se connecter et ne sont pas comptabilisés à des fins de facturation. Les utilisateurs peuvent être désactivés automatiquement après une période d’inactivité via un paramètre de site ou une planification à désactiver après une date spécifique.

disabled_expired_or_inactive
disabled_expired_or_inactive boolean

Propriété calculée qui retourne true si l’utilisateur a désactivé ou expiré ou inactif.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur

filesystem_layout
filesystem_layout string

Disposition du système de fichiers

first_login_at
first_login_at string

Première connexion de l’utilisateur

ftp_permission
ftp_permission boolean

L’utilisateur peut-il accéder avec FTP ou FTPS ?

group_ids
group_ids string

Liste séparée par des virgules d’ID de groupe dont cet utilisateur est membre

header_text
header_text string

Texte à afficher pour l’utilisateur dans l’en-tête de l’interface utilisateur

language
language string

Langage préféré

last_login_at
last_login_at string

Heure de connexion la plus récente de l’utilisateur via n’importe quel protocole

last_web_login_at
last_web_login_at string

Heure de connexion la plus récente de l’utilisateur via le web

last_ftp_login_at
last_ftp_login_at string

Heure de connexion la plus récente de l’utilisateur via FTP

last_sftp_login_at
last_sftp_login_at string

Heure de connexion la plus récente de l’utilisateur via SFTP

last_dav_login_at
last_dav_login_at string

Heure de connexion la plus récente de l’utilisateur via WebDAV

last_desktop_login_at
last_desktop_login_at string

Heure de connexion la plus récente de l’utilisateur via l’application De bureau

last_restapi_login_at
last_restapi_login_at string

Heure de connexion la plus récente de l’utilisateur via l’API Rest

last_api_use_at
last_api_use_at string

Heure d’utilisation de l’API la plus récente de l’utilisateur

date_dernière_activité
last_active_at string

L’heure d’activité la plus récente de l’utilisateur, qui est la dernière connexion, l’utilisation, l’activation ou la création de l’API la plus récente

last_protocol_cipher
last_protocol_cipher string

Protocole et chiffrement les plus récents utilisés

lockout_expires
lockout_expires string

Heure à venir que l’utilisateur ne sera plus verrouillé s’il y a lieu

nom
name string

Nom complet de l’utilisateur

entreprise
company string

Entreprise de l’utilisateur

Remarques
notes string

Toutes les notes internes sur l’utilisateur

notification_daily_send_time
notification_daily_send_time integer

Heure de la journée à laquelle les notifications quotidiennes doivent être envoyées. Peut être comprise entre 0 et 23

office_integration_enabled
office_integration_enabled boolean

Activer l’intégration à Office pour le web ?

partner_admin
partner_admin boolean

Cet utilisateur est-il administrateur partenaire ?

partner_id
partner_id integer

ID de partenaire si cet utilisateur appartient à un partenaire

partner_name
partner_name string

Nom du partenaire si cet utilisateur appartient à un partenaire

password_set_at
password_set_at string

Dernière fois que le mot de passe de l’utilisateur a été défini

password_validity_days
password_validity_days integer

Nombre de jours pour permettre à l’utilisateur d’utiliser le même mot de passe

public_keys_count
public_keys_count integer

Nombre de clés publiques associées à cet utilisateur

receive_admin_alerts
receive_admin_alerts boolean

L’utilisateur doit-il recevoir des alertes d’administrateur telles que des notifications d’expiration de certificat et des dépassements ?

require_2fa
require_2fa string

Paramètre obligatoire 2FA

require_login_by
require_login_by string

Exiger que l’utilisateur se connecte à la date spécifiée dans le cas contraire, il sera désactivé.

active_2fa
active_2fa boolean

2fa est-il actif pour l’utilisateur ?

require_password_change
require_password_change boolean

Une modification de mot de passe est-elle requise lors de la prochaine connexion de l’utilisateur ?

password_expired
password_expired boolean

Le mot de passe de l’utilisateur a-t-il expiré ?

readonly_site_admin
readonly_site_admin boolean

L’utilisateur est-il autorisé à afficher toutes les configurations de site (non facturation) pour ce site ?

restapi_permission
restapi_permission boolean

Cet utilisateur peut-il accéder à l’application web, à l’application de bureau, aux kits SDK ou à l’API REST ? (Tous ces outils utilisent l’API en interne. Il s’agit donc d’un jeu d’autorisations unifié.)

self_managed
self_managed boolean

Cet utilisateur gère-t-il ses propres informations d’identification ou est-il un utilisateur partagé ou bot ?

sftp_permission
sftp_permission boolean

L’utilisateur peut-il accéder à SFTP ?

site_admin
site_admin boolean

L’utilisateur est-il administrateur pour ce site ?

site_id
site_id integer

ID de site

skip_welcome_screen
skip_welcome_screen boolean

Ignorez la page d’accueil de l’interface utilisateur ?

ssl_required
ssl_required string

Paramètre ssl requis

sso_strategy_id
sso_strategy_id integer

ID de stratégie de l’authentification unique (par authentification unique) pour l’utilisateur, le cas échéant.

subscribe_to_newsletter
subscribe_to_newsletter boolean

L’utilisateur est-il abonné à la newsletter ?

externally_managed
externally_managed boolean

Cet utilisateur est-il géré par un SsoStrategy ?

tags
tags string

Liste de balises séparées par des virgules pour cet utilisateur. Les balises sont utilisées pour d’autres fonctionnalités, telles que UserLifecycleRules, qui peuvent cibler des balises spécifiques. Les balises doivent contenir uniquement des lettres minuscules, des chiffres et des traits d’union.

fuseau horaire
time_zone string

Fuseau horaire de l’utilisateur

type_of_2fa
type_of_2fa string

Type(s) des méthodes 2FA en cours d’utilisation, pour une utilisation programmatique. Sera soit sms, yubitotpwebauthn, , ou emailplusieurs valeurs triées par ordre alphabétique et jointes par un trait de soulignement. Ne spécifie pas si l’utilisateur a plusieurs méthodes données.

type_of_2fa_for_display
type_of_2fa_for_display string

Type(s) des méthodes 2FA en cours d’utilisation, mis en forme pour l’affichage dans l’interface utilisateur. Contrairement type_of_2faà cette valeur, cette valeur est claire lorsqu’un utilisateur a plus de 1 de même type de méthode.

user_root
user_root string

Dossier racine pour FTP (et éventuellement SFTP si le paramètre approprié à l’échelle du site est défini). Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

user_home
user_home string

Dossier d’accueil pour FTP ou SFTP. Notez qu’il n’est pas utilisé pour l’API, le Bureau ou l’interface Web.

days_remaining_until_password_expire
days_remaining_until_password_expire integer

Nombre de jours restants jusqu’à l’expiration du mot de passe

password_expire_at
password_expire_at string

Date d’expiration du mot de passe

Suppression d’un groupe

Suppression d’un groupe

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID de groupe.

Supprimer l'utilisateur

Supprimer l'utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

Identifiant utilisateur.

Supprimer un fichier ou un dossier

Supprimer un fichier ou un dossier

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Supprimer un lien de partage

Supprimer un lien de partage

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID d’offre groupée.

Supprimer une notification de lien de partage

Supprimer une notification de lien de partage

Paramètres

Nom Clé Obligatoire Type Description
Id
id True integer

ID de notification de bundle.

Télécharger le fichier

Télécharger le fichier

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Retours

Contenu du fichier
binary

Télécharger le fichier

Télécharger le fichier

Paramètres

Nom Clé Obligatoire Type Description
Chemin
path True string

Chemin d’accès à l’exploitation.

Contenu du fichier
body True binary

Contenu du fichier à charger. Envoyez les octets exacts que vous souhaitez stocker dans Files.com.

Définitions

binaire

Il s’agit du type de données de base "binaire".