3.13 OAuth Integration

OAuth is the industry-standard protocol for authorization and access delegation. Any application that supports the OAuth service, can be integrated with Filr. For this integration, the application has to be registered with Filr. Filr integration with applications enables the application’s users to store their data in Filr, which means the user’s data is maintained within the enterprise firewall.

3.13.1 Applications Supported on Filr

The applications that support OAuth 2.0, can be integrated with Filr.

Table 3-10 List of Applications that support OAuth 2.0

Applications Supported

Version

  • Hybrid Workspaces

  • 22.7 (and higher)

3.13.2 Register an Application with Filr

Path: Port 8443 Filr Admin Console Management > OAuth Applications > Register

Table 3-11 Using the Register New Application dialog

Field, Option, or Button

Information and/or Action

  • Enable

  • Select the checkbox to enable the application.

  • Application Name

  • Enter the name of the name of the application you wish to register.

  • Application Admin

  • Enter the user id of the application’s administrator. If the administrator is not a Filr user, create a new user for the application’s administrator.

  • Redirect URLs (Comma separated values)

  • Enter the redirection URLs from the application to be registered for securely exchanging the authentication code and access token.

  • Check with the application’s administrator for the redirect URLs.

  • OK

  • Click OK to save the application details and complete the registration.

  • Cancel

  • Click this to clear the details entered.

On registration of an application on Filr, a Client ID is generated. This client ID has to be shared with the application administrator. The application administrator has to log in to the Filr web client and provide this client ID to retrieve the client secret.

Modifying an Application Details

Path: Port 8443 Filr Admin Console Management > OAuth Applications > Select an application > Modify.

Generally, the information in Register an Application with Filr applies to modifying the application. You can modify all the fields, except Application Name.

Deleting Applications

Path: Port 8443 Filr Admin ConsoleManagement > OAuth Applications > Select one or more Applications > Delete.

When you delete an application, all the active user sessions of registered application along with the application details are removed from Filr. The registered applications can no longer access the files and folders in Filr.

3.13.3 Generating Client Secret

When the client ID is shared with the third party application’s administrator, the third party application’s administrator can login to Filr and generate the client secret. For the information on registering an application, seeRegister an Application with Filr.

The third party application’s administrator has to enter the client secret on the registered application portal. This completes the application registration and it can use Filr as storage repository.

To generate the client secret, perform the following steps:

  1. Login to the Filr .

  2. Click on the user name on the top right corner of Filr work area and select OAuth Applications.

  3. Enter the application details in the OAuth Applications dialog.

    Table 3-12 Generate Client Secret

    Field, Option, or Button

    Information and/or Action

    • Password

    • Enter your Filr password.

    • Client ID

    • Enter the client id shared by the Filr administrator.

    • Get Secret

    • Click this button to retrieve the client secret for the application.

    • Cancel

    • Click this button to close the OAuth Applications dialog.

  4. Click Copy on the Client Secret dialog.

  5. Click Done.