Citrix ShareFile Authenticate an Element Instance

You can authenticate with Citrix ShareFile to create your own instance of the Citrix ShareFile element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Citrix ShareFile platform.

Authenticate Through the UI

Use the UI to authenticate with Citrix ShareFile and create an element instance. Because you authenticate with Citrix ShareFile via OAuth 2.0, all you need to do is add a name for the instance and provide your API key and API secret. After you create the instance, you'll log in to Citrix ShareFile to authorize Cloud Elements access to your account. For more information about authenticating an element instance, see Authenticate an Element Instance (UI). 

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

Authenticating through API follows a multi-step OAuth 2.0 process that involves:

• Getting a redirect URL. This URL sends users to the vendor to log in to their account.
• Authenticating users and receiving the authorization grant code. After the user logs in, the vendor makes a callback to the specified url with an authorization grant code.
• Authenticating the element instance. Using the authorization code from the vendor, authenticate with the vendor to create an element instance at Cloud Elements.

Getting a Redirect URL

Use the following API call to request a redirect URL where the user can authenticate with the service provider. Replace {keyOrId} with the element key, sharefile.

curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Example cURL

curl -X GET \
  'https://api.cloud-elements.com/elements/api-v2/elements/sharefile/oauth/url?apiKey=fake_api_key&apiSecret=fake_api_secret&callbackUrl=https://www.mycoolapp.com/auth&state=sharefile' \

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
"oauthUrl": "https://secure.sharefile.com/oauth/authorize?client_id=tkRrJHtoCrJG1kq3D22aQD8UNhocboRw&response_type=code&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=sharefile",
"element": "sharefile"
}

Authenticating Users and Receiving the Authorization Grant Code

Provide the response from the previous step to the users. After they authenticate, Citrix ShareFile provides the following information in the response:

• code
• state

Authenticating the element Instance

Use the /instances endpoint to authenticate with Citrix ShareFile and create an element instance. If you are configuring events, see Citrix Sharefile Events.

To authenticate an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "sharefile"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.callback.url": "<CALLBACK_URL>",
       "oauth.api.key": "<CONSUMER_KEY>",
       "oauth.api.secret": "<CONSUMER_SECRET>",
       "document.root.folder.name": "</ROOT_DIR>",
       "sharefile.subdomain": "<SUBDOMAIN>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "sharefile"
  },
  "providerData": {
    "code": "xxxxxxxxxxxxxxxxxxxxxxx"
  },
  "configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "document.root.folder.name": "/top",
    "sharefile.subdomain": "example"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Example Response for an Authenticated Element Instance

{
  "id": 1234,
  "name": "Test",
  "token": "zg1dx35BCjiKo+pbTQS3dxcAKlfZcNVOWtI=",
  "element": {
    "id": 450,
    "name": "Sharefile",
    "key": "sharefile",
    "description": "Sharefile Element",
    "image": "https://lh6.googleusercontent.com/--zcBqgYsBHE/AAAAAAAAAAI/AAAAAAAAAks/ICvceS9qZ-I/s0-c-k-no-ns/photo.jpg",
    "active": true,
    "deleted": false,
    "typeOauth": true,
    "trialAccount": false,
    "transformationsEnabled": true,
    "bulkDownloadEnabled": false,
    "bulkUploadEnabled": false,
    "cloneable": true,
    "authentication": {
      "type": "oauth2"
    },
    "hub": "documents",
    "parameters": []
  },
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {
    "base.url": "https://{sharefile.subdomain}.sf-api.com/sf/v3",
    "oauth.api.secret": "SHAREFILE_API_SECRET",
    "event.notification.subscription.id": null,
    "pagination.max": "100",
    "event.vendor.type": "polling",
    "oauth.user.token": "ydDkYnjaxBiywa8jYBub2UQikA7SqlnD$$FRvqiwAdMEtRijHvyqeD",
    "sharefile.token.url": "https://secure.sharefile.com/oauth/token?grant_type=authorization_code",
    "pagination.type": "",
    "event.poller.refresh_interval": "5",
    "event.notification.callback.url": null,
    "event.notification.signature.key": null,
    "oauth.user.refresh_token": "ydDkYnjaxBiywa8jYBub2UQikA7SqlnD$$t5A4a5oU7FYJeZwa4V7LZzrl82AmdG9xmH8",
    "sharefile.subdomain": "cloudelements",
    "event.poller.urls": "documents|/hubs/documents/events/poll/documents?where=lastmodifieddate='${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
    "sharefile.auth.url": "https://secure.sharefile.com/oauth/index.aspx",
    "oauth.api.key": "SHAREFILE_API_KEY",
    "sharefile.callback.url": "https://httpbin.org/get",
    "oauth.user.refresh_time": "1461625686998",
    "sharefile.format": "json",
    "event.notification.enabled": "false"
  },
  "eventsEnabled": false,
  "cachingEnabled": false,
  "traceLoggingEnabled": false
}