Egnyte is a cloud-based content platform that helps organizations manage, secure, and govern their cloud files. The Egnyte connector enables Glean to index files and folders from a customer’s Egnyte instance, enforcing Egnyte’s native user permissions so content remains discoverable only by authorized users. The integration uses Egnyte’s REST APIs and is configured and managed from within Glean’s deployment console.

Supported Features and Limitations

Glean’s Egnyte connector is designed to index, enforce permissions for, and provide search experiences over core Egnyte content. The following sections outline the connector’s capabilities and current constraints.

Supported Objects/Entities

  • Files
  • Folders

Supported API Endpoints/Features

  • File System API: Used for initial and periodic crawling of file and folder content.
  • User Management API: Pulls the list of users with access to the Egnyte environment.
  • Group Management API: Retrieves user groups for accurate permission enforcement.
  • Audit Reporting API: Optionally ingests document access audit data.

Limitations

  • Descriptions and comments added to files within the Egnyte web UI are not indexed; these are unavailable through Egnyte’s API.
  • Link sharing is unsupported. Due to Egnyte’s complex sharing models, content shared via links is excluded from Glean search for those with access only by link.
  • Only a single Egnyte domain/instance can be connected per Glean environment at this time.
  • Webhook registration may require manual intervention in some environments.
  • Crawling speed is impacted by Egnyte API rate limits. For large document sets, initial or full recrawls may take a substantial amount of time.

Requirements

Several prerequisites and configuration steps must be completed prior to using the connector. These ensure secure connectivity and accurate permission enforcement.

Technical Requirements

  • Access to Glean’s deployment console within the customer’s GCP project.
  • An active Egnyte enterprise account with administrative privileges.
  • Sufficient API quota on Egnyte for expected crawl volume and frequency (roughly 2 QPS by default, can be increased by requesting with Egnyte support).

Credential Requirements

  • An Egnyte administrator account is needed to authorize the connector.
  • OAuth 2.0 is used for secure authentication between Glean and Egnyte.
  • During setup, admins must initiate an OAuth authorization flow from Glean’s deployment console.

Permission Requirements

  • The Egnyte admin role is required for initial setup to grant connector permissions and obtain OAuth tokens.
  • Glean enforces Egnyte user and group-level access controls at query time, ensuring users see only what they are permitted to see in Egnyte.

Preliminary Source/System Setup

  • Determine your Egnyte instance domain (format: https://yourdomain.egnyte.com).
  • Log into Egnyte as an admin and prepare to initiate the OAuth 2.0 flow.
  • Review any specific security or privacy policies for folder and file paths that should be excluded from crawling.

External References

  • Egnyte REST API documentation
  • Egnyte API Usage Restrictions: helpdesk.egnyte.com/hc/en-us/articles/17683455594125-Public-API-Usage-Restrictions-by-Plan

Configuration and Setup Instructions

Connector setup is initiated and largely managed via the Glean deployment console. The process requires administrative access in Egnyte and Glean.

Prerequisites

  • Access to the Glean deployment console.
  • Administrative credentials for your Egnyte account.

Authentication and Credentials

  • Visit the Glean deployment console and begin adding an Egnyte data source.
  • Enter your Egnyte domain (e.g., https://yourdomain.egnyte.com) in the setup field.
  • Start the authorization flow, which redirects to Egnyte for OAuth login and consent.
  • Upon successful authorization, Glean is granted access to index content and manage crawls.

Step-by-Step Setup

  1. In the Glean deployment console, select “Add data source” and choose Egnyte.
  2. Input the Egnyte domain in the correct format. For most environments, this is https://yourdomain.egnyte.com. (Note: Some environments may require omitting “.com” per recent escalations—check your deployment console for the field validation logic.)
  3. Click the authorization link to begin the OAuth 2.0 flow. You will be redirected to Egnyte to log in and authorize Glean.
  4. Upon completion, follow any on-screen instructions to verify connection and manage optional configuration settings:
    • Exclude folder paths or specific files using prefix patterns to limit indexing of sensitive content.
    • Specify a test user list if access needs to be limited prior to full rollout.
  5. Complete configuration and monitor crawl progress through the console.

Additional Configuration Options

  • Exclude folders/files: Use regex/prefix patterns to prevent indexing of sensitive material. Validate your patterns with tools like regex101.com.
  • Crawl incremental updates: Glean will do full and periodic incremental crawls to keep content and permissions in sync.
  • Note: Large Egnyte datasets may result in long crawl or re-crawl times, limited by Egnyte’s API quotas.