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 https //api sharefile com/docs/resource?name=shares 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\@sharefile com","email2\@sharefile com"],"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" "user\@company com","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" "user\@company com","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