Once an SFTP directory has been created for your institution, please contact Interfolio’s Technical Services team to setup user provisioning. Your project team will need to work with the Technical Services team to validate a test file as part of the implementation/setup process.

In order for Interfolio to process your create/update/deactivate lists, the files will need to be prepared in a specific format. Each file will be a JSON file with a file extension of “.json” and contain an array of user objects. The filenames will be as follows: 

add.json 
update.json 
deactivate.json 

Users listed in the “add” file will be created and associated with your institutional hierarchy. Users listed in the “update” file will have their attributes updated to match those contained in the file. Users listed in the “deactivate” file will have their hierarchical permissions and access revoked. The full user object within the Interfolio API contains the following attributes: 

{ 
"first_name": string, 
"last_name": string, 
"email": string, 
"institution_user_id": string, 
"external_user": boolean, 
"eppn": string, 
"unit_id": integer 
} 

After preparing your lists of users, the next step is to prepare the package to upload to Interfolio’s SFTP server. The package will be a “TAR” file with a file extension of “.tar” and will have a specific naming convention, “prefix_date_service.tar”. The “prefix” will be your SFTP username. The date will be in “YYYYMMDD” format. The service will be either “Search” (for Faculty Search) or “Tenure” (For Review, Promotion, & Tenure) depending on the service in which you’re adding / updating / deactivating the given users. An example filename would be “charlie_20170123_tenure.tar”. You can create this file by running one of the following terminal commands:

$ tar -cvf charlie_20170123_tenure.tar /users 
$ tar -cvf charlie_20170123_tenure.tar add.json update.json deactivate.json 

1. Now that you have the package of user files prepared, the next step is to upload the package to Interfolio’s SFTP server. First, log into the SFTP with the following credentials, provided to you at the time of setup:
   • Connection Type: SFTP (SSH File Transfer Protocol)
   • Server/Host: transfer.ops.interfolio.com
   • Username: [Your Interfolio-provided username]
   • Password: None
   • SSH Key: Your private key
2. You can connect using the private key you set up, and please work with your IT staff to ensure permit access to TCP Port 22 (SSH) destination in your institution’s firewalls as follows: transfer.ops.interfolio.com (3.215.32.29, 52.202.198.155)
3. Next, change directory into the “incoming” directory by running the following:
   sftp> cd incoming
4. Finally, upload your file to the “incoming” directory by running the following:
   sftp> put charlie_20170123_tenure.tar
5. That’s it! That’s all you need to do. From there, the Interfolio SFTP service will take over and process your files. If you have any questions, please contact your Interfolio-support@elsevier.com or your Client Success Manager.

When provisioning users via SFTP, you can include arbitrary “key”:”value” pairs expressed as JSON. This data is saved as metadata and can be used for reporting purposes. Below is an example of what to include in these files. In this example, the additional parameters of “favorite_color” and “on_site” are stored as metadata: 

[ 
{ 
"first_name": "Joe", 
"last_name": "User", 
"email": "joe.user@interfolio.com", 
"unit_id": 9557, 
"university_user_id": "jhu3v", 
"favorite_color": "green", 
"on_site": false 
}, 
{ 
"first_name": "Jane", 
"last_name": "Doe", 
"email": "jane.doe@interfolio.com", 
"university_user_id": "jld8e", 
"favorite_color": "blue", 
"on_site": true 
} 
]