Citrix ShareFile API
  • Not Currently Logged In |
    Log In
  • ||
    Logout
  • arrow Getting Started
    • Quick Start Guide
    • OData Implementation
    • FAQ
    • Authentication
    • Postman
    • Storage Zones
  • Get an API Key
  • arrow API Entities
    • AccessControls
    • Accounts
    • Apps
    • AsyncOperations
    • Capabilities
    • ConnectorGroups
    • Devices
    • EncryptedEmails
    • FavoriteFolders
    • Favorites
    • FolderTemplates
    • Groups
    • Items
    • Metadata
    • migration-guide
    • Policies
    • Reports
    • Sessions
    • Shares
    • StorageCenters
    • Users
    • WebhookClients
    • WebhookSubscriptions
    • Workflows
    • Zones
  • arrowWebhooks
    • Overview
    • Events
    • Payloads
    • Signature Keys
  • arrowHow-To Guides
    • Common Use Cases
    • Troubleshooting
  • arrowCode Samples
    • C#(.NET)
    • Command Line / CURL
    • Java SE
    • PHP
    • Python
    • Ruby
    • VB(.NET)
  • arrowSDKs
    • PowerShell
    • .NET
    • JAVA
    • JavaScript
  • Change Log
  • V1 to V3 Migration

Using Postman with OAuth

Getting a ShareFile Client Id and Secret

The first step will be to get a Client Id and Secret that is compatible with Postman. First navigate to our ShareFile API Key Generator. On this page you will be able to log into your ShareFile account and you will be present with a web form. ShareFile Client Request form

Make sure that the Redirect URI is set up to be used with Postman. Simply put 'https://www.getpostman.com/oauth2/callback' as your Redirect URI and then generate the key

Using Postman

Now that you have your Client ID and Secret you are ready to use Postman. Open up the application and click on the OAuth 2.0 tab at the top, and enter the following values:

  • Authorization URL: https://secure.sharefile.com/oauth/index.aspx?redirect_uri=https://www.getpostman.com/oauth2/callback
  • Access Token URL: https://secure.sharefile.com/oauth/token?grant_type=authorization_code
  • Client ID/ Client Secret: The Id and Secret generated on the previous step
Postman 3 OAUth 2.0 form Once you’ve entered your values, click on “Get access token” and you will get a ShareFile login prompt. Enter your username and password and you will be redirected back to Postman with your access token and refresh tokens. Enter a name for your token and click Save. Postman 3 Get Token

From here click on the “Get access token” button and you should see the following form Postman 3 Save Token Name

In order to execute a request you will need to add the token to your header; this will be an option once you have saved. Click the Radio button to select this option and then click the saved token name. Postman 3 Add Token header

This will add the Authorization Bearer to your query. Then you can add in a request url and hit send to execute. You can try https://account.sf-api.com/sf/v3/Items as an example to start. Postman 3 Send Token Request