Citrix Share File
The Citrix ShareFile connector enables seamless integration with Citrix's file sharing and storage services, facilitating secure and efficient file management operations.
Citrix ShareFile is a secure content collaboration, file sharing, and sync solution that supports all the document-centric tasks and workflow needs of small and large businesses. The Citrix ShareFile connector for Swimlane Turbine enables users to automate file sharing processes, manage access to files, and streamline file upload and download workflows. By integrating with Citrix ShareFile, Swimlane Turbine users can enhance their security automation capabilities, ensuring sensitive documents are handled securely and efficiently within their security operations.
Prerequisites
To effectively utilize the Citrix ShareFile connector with Swimlane Turbine, ensure you have the following prerequisites:
- OAuth2 Password Credentials authentication with the following parameters:
- URL: The endpoint URL for the Citrix ShareFile API.
- Username: Your Citrix ShareFile account username.
- Password: Your Citrix ShareFile account password.
- Client ID: The client identifier assigned to your application.
- Client Secret: The secret key associated with your client ID.
Capabilities
This connector provides the following capabilities:
- Deliver Request a File Email
- Downloads Share Items
- Downloads Share Items By Item ID
- Get List of Shares
- Get Recipient of a Share
- Get Share
- Upload File to Request Share
Notes
Configurations
Citrix ShareFile Oauth 2.0 Password Grant
Authenticates using oauth 2.0 client credentials
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | Server Host Address. | string | Required |
oauth2_username | Account Username. | string | Required |
oauth2_password | Account Password. | string | Required |
client_id | The client ID. | string | Required |
client_secret | The client secret. | string | Required |
verify_ssl | Verify SSL certificate. | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Deliver Request a File Email
Sends an email with a link to upload files to a specified folder in Citrix ShareFile.
Endpoint
- URL: /sf/v3/Shares/Request
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
FolderId | string | Optional | The Folder ID for this Request. Has precedence over FolderPath. |
FolderPath | string | Optional | The path to the Folder for this Request. |
Emails | array | Optional | List of emails to whom this Share should be sent. |
Subject | string | Optional | The subject of the Share email. |
Body | string | Optional | A message to be included in the Share email body. |
CcSender | boolean | Optional | If true, the Share sender will be CC'd in the Share email. |
NotifyOnUpload | boolean | Optional | If true, the sender will receive an email notification when files are uploaded to the Share. |
RequireLogin | boolean | Optional | If true, recipients will need to login to access the Share. |
ExpirationDays | number | Optional | Number of days until access to this Share expires. |
IsViewOnly | boolean | Optional | If true, the Share items can only be viewed but not downloaded. Not applicable for Request Shares. |
Input Example
{"json_body":{"FolderId":"folderId","FolderPath":"","Emails":["[email protected]","[email protected]"],"Subject":"","Body":"","CcSender":false,"NotifyOnUpload":true,"RequireLogin":false,"ExpirationDays":-1,"IsViewOnly":true}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{}}
Downloads Share Items
Downloads specified items from a Citrix Share File share using the provided shareId.
Endpoint
- URL: /sf/v3/Shares({{shareId}})/Download
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.shareId | string | Required | The Share ID. |
parameters.Name | string | Optional | In the format of FirstName LastName. |
parameters.Email | string | Optional | Parameters for the Downloads Share Items action |
parameters.Company | string | Optional | Parameters for the Downloads Share Items action |
parameters.id | string | Optional | The Item ID. |
parameters.redirect | boolean | Optional | if true (default), the response is a 302 to the target object. Otherwise, caller recieves a DownloadSpecification object on a 200 return. |
Input Example
{"parameters":{"Name":"username","Email":"[email protected]","Company":"A","id":"","redirect":true},"path_parameters":{"shareId":"1"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
file | object | Output field: file |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","file":[]}
Downloads Share Items By Item ID
Downloads specified items from Citrix ShareFile using the share and item IDs provided in the path parameters.
Endpoint
- URL: /sf/v3/Shares({{shareId}})/Download({{itemid}})
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.shareId | string | Required | The Share ID. |
path_parameters.itemid | string | Required | The Item ID. |
parameters.Name | string | Optional | In the format of FirstName LastName. |
parameters.Email | string | Optional | Parameters for the Downloads Share Items By Item ID action |
parameters.Company | string | Optional | Parameters for the Downloads Share Items By Item ID action |
parameters.redirect | boolean | Optional | if true (default), the response is a 302 to the target object. Otherwise, caller recieves a DownloadSpecification object on a 200 return. |
Input Example
{"parameters":{"Name":"username","Email":"[email protected]","Company":"A","redirect":true},"path_parameters":{"shareId":"","itemid":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
file | object | Output field: file |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","file":[]}
Get List of Shares
Retrieve all outstanding Shares associated with the authenticated Citrix ShareFile user.
Endpoint
- URL: /sf/v3/Shares
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.includeExpired | boolean | Optional | Specifies whether or not expired shares should be returned. Set to true by default. |
Input Example
{"parameters":{"includeExpired":true}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{}}
Get Recipient of a Share
Retrieves details of a specific share recipient in Citrix ShareFile using the provided parent and alias IDs.
Endpoint
- URL: /sf/v3/Shares({{parentid}})/Recipients({{id}})
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.parentid | string | Required | The Share ID. |
path_parameters.id | string | Required | The Alias ID. |
Input Example
{"path_parameters":{"parentid":"","id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{}}
Get Share
Retrieves a single Share entity from Citrix ShareFile based on the specified 'id' path parameter.
Endpoint
- URL: /sf/v3/Shares({{id}})
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | The Share ID. |
parameters.includeExpired | boolean | Optional | Specifies whether or not expired shares should be returned. Set to false by default. |
Input Example
{"parameters":{"includeExpired":false},"path_parameters":{"id":"1"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Thu, 2 May 2024 20:37:23 GMT"},"reason":"OK","json_body":{}}
Upload File to Request Share
Uploads a file to a specified share request in Citrix ShareFile, requiring the 'id' as a path parameter.
Endpoint
- URL: /sf/v3/Shares({{id}})/Upload
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
files | array | Required | File to be uploaded |
files.file_name | string | Required | Name of the resource |
files.file | string | Required | Parameter for Upload File to Request Share |
path_parameters.id | string | Required | The share ID. |
Method | string | Optional | HTTP method to use |
Raw | boolean | Optional | Parameter for Upload File to Request Share |
FileName | string | Optional | Name of the resource |
FileLength | number | Optional | Parameter for Upload File to Request Share |
FileSize | number | Optional | Parameter for Upload File to Request Share |
BatchId | string | Optional | Unique identifier |
BatchLast | boolean | Optional | Parameter for Upload File to Request Share |
CanResume | boolean | Optional | Parameter for Upload File to Request Share |
StartOver | boolean | Optional | Parameter for Upload File to Request Share |
Tool | string | Optional | Parameter for Upload File to Request Share |
Overwrite | boolean | Optional | Parameter for Upload File to Request Share |
Title | string | Optional | Parameter for Upload File to Request Share |
Details | string | Optional | Parameter for Upload File to Request Share |
IsSend | boolean | Optional | Parameter for Upload File to Request Share |
SendGuid | string | Optional | Unique identifier |
Opid | string | Optional | Unique identifier |
ThreadCount | number | Optional | Count value |
ResponseFormat | string | Optional | Parameter for Upload File to Request Share |
Notify | boolean | Optional | Parameter for Upload File to Request Share |
ClientCreatedDateUTC | string | Optional | Parameter for Upload File to Request Share |
ClientModifiedDateUTC | string | Optional | Parameter for Upload File to Request Share |
Input Example
{"json_body":{"Method":"Method","Raw":false,"FileName":"FileName","FileLength":123,"FileSize":123,"BatchId":"","BatchLast":true,"CanResume":true,"StartOver":true,"Tool":"","Overwrite":true,"Title":"","Details":"","IsSend":true,"SendGuid":"","Opid":"","ThreadCount":1,"ResponseFormat":"","Notify":true,"ClientCreatedDateUTC":"2024-01-02T09:42:36.320Z","ClientModifiedDateUTC":"2024-02-02T09:42:36.320Z","ExpirationDays":-1},"path_parameters":{"id":""}}
Output
Parameter | Type | Description |
|---|---|---|
status | string | Status value |
response | object | Output field: response |
Output Example
{"status":"success","response":{}}
Response Headers
Header | Description | Example |
|---|---|---|
content-length | The length of the response body in bytes | 140 |
content-type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 2 May 2024 20:37:23 GMT |