Configuration reference for file transfers to or from external users

9.0.20.000 This page provides information for creating payload JSON files that are required for the configuration of file transfers to and from external users.

For each type of object involved in file transfers — external user, virtual folder, and group (of users) — a separate type of JSON file is required.

External User Data file

The following code sample demonstrates how to define an external user in the JSON file:

{ 
   "name": "username1",
   "email": "aaa@bbb.com",
   "description": "description",
   "company": "companyName",
   "phoneNumber": "44-16-5555555",
   "password": "********",
   "sshKey": "key",
   "as2Key": {
      "id": "as2KeyId",
      "partnersCertificateAlias": "partner_certificate",
      "destinationFolder": "folder_dest1"
   }
}

The External User Data file contains the following properties for each external user:

Property	Description
name	Name of the external user The name must be unique, that is, not used by any other external user or user group.
email	Email address of the user
description	(Optional) A textual description of the user
company	Name of the company with which the user is associated
phoneNumber	(Optional) The user's phone number
password	A password that controls the user's access to the file transfer mechanism To specify the password, enter one of the following inputs: Plain text Predefined secret, with the following format: `"Secret:<secretKey>"` If you are updating user definitions and do not want to change the existing password, enter the following string: `KEEP_EXISTING` Note: If you specify a password, you do not need to specify an SSH key (the next property).
sshKey	A key and passphrase for an SSH connection to a remote host Note: If you specify an SSH key, you do not need to specify a password (the previous property).
as2Key	Specifications of a key for an Applicability Statement 2 (AS2) connection, which you can use to transfer Electronic Data Interchange (EDI) messages. AS2 key specifications are optional when updating the definitions of an existing external user. Do NOT include AS2 key specifications when defining a new external user.
as2Id	Unique AS2 identification (ID)
certificate	Name of the AS2 certificate
destinationFolder	A destination folder to use in AS2 connections, one of the virtual folders associated with this external user

Folder Properties Data file

The following code sample demonstrates how to define a virtual folder in the JSON file:

{
    "name": "folder_1",
    "authorizedInternalUsers": [ "username1","username2"],
    "authorizedExternalUsersAndGroups": [ "username1","username2"],
    "deleteFilesAfterDownload": true,
    "notifyByEmailWhenFileArrive" : true,
    "retentionPolicy": 10,
    "sizeLimit": 100,
    "allowedFilePattern":"*.zip",
    "blockedFilePattern":"*.exe"
}

The Folder Properties Data file contains the following properties for each virtual folder:

Property	Description
name	Name of the virtual folder
authorizedInternalUsers	Any number of internal users that are authorized to access this folder
authorizedExternalUsersAndGroups	Any number of external users and user groups that are authorized to access this folder
deleteFilesAfterDownload	Whether to delete an incoming file (that is, a file uploaded by an external user) after it has been downloaded by an internal user Possible values: true or false (the default)
notifyByEmailWhenFileArrive	Whether to send an email of notification to allowed users when a new file arrives and is ready for download Possible values: true or false (the default)
retentionPolicy	Maximum number of hours to keep the file, before it is automatically deleted If you do not want to limit the retention time, specify a value of 0 (the default).
sizeLimit	Maximum number of gigabytes allowed in the virtual folder before file uploading is blocked for external and internal users Default: 0
allowedFilePattern	(Optional) A file pattern for the files that external users are allowed to upload to this virtual folder. Include the asterisk wildcard in the specified pattern. By default, all files are allowed in the folder. Use this property to limit the allowed files by whitelisting a specific pattern.
blockedFilePattern	(Optional) A file pattern for files that external users are NOT allowed to upload to this virtual folder. Include the asterisk wildcard in the specified pattern. By default, all files are allowed in the folder. Use this property to blacklist certain files based on a file pattern.

User Group Properties Data file and User Group Details Data file

The following code sample demonstrates how to define a new user group in the UserGroupPropertiesData JSON file:

{ 
"name": "group1",
"externalUsers": ["user1", "user2"],
"ldapGroups": ["ldapGroup1","ldapGroup2"]
}

If you are updating an existing user group, you use a UserGroupPropertiesData JSON file, in which you do NOT specify the name of the group:

{ 
"externalUsers": ["user1", "user2"],
"ldapGroups": ["ldapGroup1","ldapGroup2"]
}

These data files contain the following properties for each group of users:

Property	Description
name	(Only if adding a new user group) Name of the user group
externalUsers	Any number of external users to include in the group
ldapGroups	Any number of LDAP groups to include in the group

Configuration reference for file transfers to or from external users

External User Data file

Folder Properties Data file

User Group Properties Data file and User Group Details Data file

Comments