Skip to main content
Egnyte
Previewv1.1.0
38 actions · 21 events · 2 auth methods
Documents

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0 (Public Application)

OAuth 2.0 Authorization Code flow. Egnyte issues access tokens that expire after 30 days plus a rotating refresh token p…

Connector Profile · OAuth 2.0 (Internal Application)

For customer-built Internal Applications on a single Egnyte domain. Uses the OAuth 2.0 Resource Owner Password Credentia…
Optionally, configure receiving Events for Egnyte into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0 (Public Application)

Link Account · OAuth 2.0 (Internal Application)

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
38 actions
Action
Description
Required scopes
Add Comment
Add a comment (note) to a file or folder in Egnyte, identified by its absolute path.
List Comments
List comments associated with a file or folder. Filter by path, ISO 8601 time window, and paginate with offset/count.
Get Comment
Retrieve the details of a single comment by its UUID.
Delete Comment
Delete a comment identified by its UUID.
Get Events Cursor
Fetch the current event stream cursor for this Egnyte tenant. Returns the latest and oldest event IDs along with a times…
List Events (v2)
Poll the Egnyte event stream for file system, note, and permission changes starting after a given cursor ID. Wait at lea…
Get File Or Folder Metadata (v2)
Retrieve metadata for a file or folder at the given Egnyte path. Optionally list folder contents, include permissions, l…
File Or Folder Operation (v2)
Perform a filesystem operation on a file or folder at the given path — create a folder, move, copy, rename, lock, or unl…
Delete File Or Folder (v2)
Delete a file or folder at the given path. Optionally scope deletion to a single file version via entry_id.
Get File Or Folder Metadata By ID
Retrieve metadata for a file or folder using its persistent ID (group_id for files, folder_id for folders).
File Or Folder Operation By ID
Move or copy a file or folder identified by its persistent ID (group_id / folder_id).
Delete File Or Folder By ID
Delete a file or folder identified by its persistent ID (group_id / folder_id). Optionally scope deletion to a single fi…
Get Folder Statistics By ID
Retrieve aggregate statistics (item counts, sizes) for a folder identified by its folder_id.
Download File Content By Path
Download the binary content of a file at the given Egnyte path. Optionally scope the download to a specific file version…
Upload File Content By Path
Upload a file’s binary content to the given Egnyte path. Creates the file if it does not exist; overwrites it if it does…
Download File Content By ID
Download the binary content of a file identified by its persistent group_id. Optionally scope the download to a specific…
Chunked Upload By File ID
Upload a single chunk of a large file (identified by its persistent group_id) as part of a chunked upload. Recommended c…
Modify Folder Options
Update folder-level configuration such as description, link behaviour, move/delete restrictions, permission inheritance,…
List Groups
List groups on the Egnyte domain. Supports SCIM-style filter syntax on displayName and paginates via startIndex/count.
Create Group
Create a new group on the Egnyte domain with the given displayName and initial member list.
Get Group
Retrieve the details of a group by its groupId, including its displayName and member list.
Replace Group
Fully replace a group — set its displayName and the complete member roster in one call. Any existing member NOT in the s…
Partially Update Group
Partially update a group — rename via displayName or remove members incrementally via a members array of `{value, op…
Delete Group
Delete a group by its groupId.
List Links (v2)
List shareable file and folder links on the domain. Filter by path, username, link type, or accessibility. Paginate with…
Create Link (v1)
Create a shareable file, folder, or upload link for a given path. Configure accessibility (anyone / password / domain /…
Get Link (v1)
Retrieve the details of a shareable link by its linkId.
Delete Link (v1)
Delete a shareable link by its linkId.
Get Effective Permissions For User
Retrieve the effective folder permissions for a specific user on a specific folder path. Both username and folder ar…
Search Files And Folders (v2)
Search for files and folders across the Egnyte domain using keywords and/or custom metadata filters. Supports pagination…
Get User Info
Return basic information (username, email, first_name, last_name, phone, is_admin, is_service_account) about the user as…
Restore Or Purge Trash Items
Restore items from the Egnyte trash back to their original location, or permanently delete (purge) them. Provide the act…
List Trash Contents (v2)
List items in the Egnyte trash with extended sort options and a deletedBy/date-range filter. Only administrators or powe…
List Users
List users on the Egnyte domain. Supports SCIM-style filter expressions, 1-based startIndex pagination, and count up to…
Create User
Create a new user on the Egnyte domain. Requires userName, email, name (givenName + familyName), active flag, authType,…
Get User
Retrieve a single Egnyte user by their numeric user ID.
Update User
Partially update an Egnyte user. Any subset of email, name (givenName/familyName), active, authType, userType, and other…
Delete User
Delete an Egnyte user by their numeric user ID.

Events

|
21 events
Event
Description
Tags
File Added Webhook
Fires when a file (or new version) is uploaded to a monitored folder.
File System
Folder Added Webhook
Fires when a folder is created in a monitored path.
File System
File Copied Webhook
Fires when a file is copied into a monitored folder.
File System
Folder Copied Webhook
Fires when a folder is copied into a monitored path.
File System
File Moved Webhook
Fires when a file is moved or renamed inside a monitored folder.
File System
Folder Moved Webhook
Fires when a folder is moved or renamed inside a monitored path.
File System
File Deleted Webhook
Fires when a file is deleted from a monitored folder.
File System
Folder Deleted Webhook
Fires when a folder is deleted from a monitored path.
File System
Trash Item Permanently Deleted Webhook
Fires when a file or folder is permanently removed from trash.
File System
Trash Item Restored Webhook
Fires when a file or folder is restored from trash.
File System
Download Link Created Webhook
Fires when a file or folder download share link is created.
Links
Upload Link Created Webhook
Fires when a public upload link is created.
Links
Download Link Deleted Webhook
Fires when a file or folder download link is deleted.
Links
Upload Link Deleted Webhook
Fires when a public upload link is deleted.
Links
Comment Added Webhook
Fires when a note is added to a file or folder.
Comments
Comment Removed Webhook
Fires when a note is removed from a file or folder.
Comments
Group Created Webhook
Fires when a new group is created on the domain.
Groups
Group Deleted Webhook
Fires when a group is deleted from the domain.
Groups
Group Renamed Webhook
Fires when a group’s name is changed.
Groups
Group Members Added Webhook
Fires when one or more users are added to a group.
Groups
Group Members Removed Webhook
Fires when one or more users are removed from a group.
Groups