How to Prepare for SFTP File Uploads with OneRoster
This article outlines the information required for SFTP file uploads, specifically in the context of integrating with the OneRoster file format.
Required details
To successfully perform SFTP file uploads, you will need the following information:
-
SFTP Credentials:
- Hostname or IP address of the SFTP server
- Port number (default is usually 22)
- Username and password for authentication
-
File Format: Ensure that the file you are uploading is in the correct format. For OneRoster integration, the supported format is the OneRoster file format.
-
File Structure: The file should adhere to the structure specified by the OneRoster. If the standard format does not meet your needs, a custom mapping format may be used.
-
Upload Process: You will need to follow the specific steps provided by your SFTP service or integration partner for uploading files. This may include using an SFTP client or command-line tools.
-
Link for File Transfer: If applicable, ensure you have a valid link for file transfer, which may be provided by your integration partner. For example, a 48-hour link may be issued for file uploads.
Conclusion
When preparing for SFTP file uploads, ensure you have the necessary credentials, the correct file format, and an understanding of the upload process. Following these guidelines will facilitate a smooth integration with the OneRoster format. If you have further questions or need assistance, please reach out to your support specialist.