SFTP (Secure File Transfer Protocol) is a secure mechanism for transferring files from one location to another. In other words, it could be said that it is a kind of "folder" where files can be stored and read, and then extracted and used in another location.

While any type of file can be added to SFTP, for user provisioning we only accept CSV (Comma Separated Values) files, which are files with comma-separated values.

To generate this integration, you can choose between these two options:

If you choose for StarMeUp to provide the SFTP, then we will generate an authentication method by user and a pem file. In addition, to increase security, we add restrictions by IP addresses or by address range to the access credentials.

Our authentication method and security measures guarantee that the SFTP can only be accessed with the appropriate credentials and from authorized locations.

If you choose to provide your own SFTP, you can define your own authentication conditions. In this case, all you have to do is share the access data with us.

Once you have decided who is providing the SFTP, you must define the structure of the CSV files.

You can download our CSV file structure and use the fields already defined by StarMeUp to dump all the information from your community.

To see how to download the CSV file template, click here.

If you want to use your own CSV file structure, the category names of your user base in CSV format must match ours. Therefore, we ask that you inform us of the names of the equivalences defined by StarMeUp. For example, if you call the field firstName, you must notify us.

Verify that your CSV file complies with the date format YYYY-MM-DD (1993-12-21), UTF-8 encoding and that the separator is ",".

For more information on how to bulk add users with a CSV file, click here.