Transitional Filevine OAuth Access Tokens: Technical Setup

  • Updated

This article provides detailed instructions for securely managing the secrets (OAuth Access Tokens for Filevine API integrations) provided by clients. This process is essential to ensure continued functionality of Neodeluxe applications and prebuilt automations.

This method will be used by Neostella to support Access Tokens, during November and December 2024, or until our infrastructure has fully transitioned to the new session management tooling.

Clients must obtain and provide their Filevine API OAuth Access Tokens as described here: How to Get a Filevine API OAuth Access Token.

Current Neodeluxe Products Supported by Access Tokens

  • File Sync v2 (All SharePoint and Newer S3 Clients)
  • Data Warehouse
  • Event Router (Data Stream)
  • Client Portal Flows
  • Data Governance AI
  • Advanced Task Management
  • Select Prebuilt Automations (formerly known as Vinebots)
    • Project Sync
    • Bulk Updater
    • Basic Date Calculation
    • Add Team to Project
    • Project Naming
    • Prefill Project Data
    • Create Lead Docket Opportunity
    • Advanced Conflict Check

More information here:

https://support.filevine.com/hc/en-us/articles/27944810461851-Authenticate-Requests-to-the-API-Gateway

https://developer.filevine.io/docs/v2/07b0338388c49-filevine-api-dynamic-documentation-links

Managing Filevine API OAuth Access Tokens for Neodeluxe Integrations

Prerequisites: The following steps must be completed by a user with Admin permissions in AWS Vinebots PROD account.

NOTE: During the transitional period, Neostella will use a different secret format than the one that will be used once the final solution is implemented.

Step 1: Create the Secret in AWS Secrets Manager

  1. In AWS, go to the Secrets manager interface.

  2. Find the transitional template created for the app you are connecting.
  3. Copy the content as it is described in the Description to create a new secret.

  4. Paste the content into a new secret.

  5. Find the placeholder xxxx in the copied content and replace it with the actual access token received from the client.

  6. Specify the name of the secret, ensuring it includes:
    • Client's Name
    • shOrgId
    • Corresponding application for which the token is used
    • The term "oauth"

Step 2: Update DynamoDB (shOrgConfig Table):

  1. Find the Global Item in the shOrgConfig table for the organization.

  2. In the relevant section of the Global Item, set the newly created secret for the corresponding system.
    Example:
    • fvapi-data-stream
    • fvapi-data-warehouse
    • fvapi-file-sync
  3. Set the apiLimit to 3000 including the line "apiLimit": 3000 on that specific object, as shown here:

 

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.