> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Egnyte

> How to set up the Egnyte connector, plus the actions and events that are available.

![Egnyte](https://stackone-logos.com/api/egnyte/filled/svg)

Previewv1.2.0[See changelog](https://docs.stackone.com/connectors/egnyte/changelog.md)

[38 actions](#actions) · [21 events](#events) · 2 auth methods

Storage

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Public Application) · Connector Profile](https://docs.stackone.com/connectors/egnyte/guides/connector-profile/oauth-2-0-public-application.md)
>
> OAuth 2.0 Authorization Code flow. Egnyte issues access tokens that expire after 30 days plus a rotating refresh token p...

> [card] [OAuth 2.0 (Internal Application) · Connector Profile](https://docs.stackone.com/connectors/egnyte/guides/connector-profile/oauth-2-0-internal-application.md)
>
> 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.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/egnyte/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Public Application) · Link Account](https://docs.stackone.com/connectors/egnyte/guides/link-account/oauth-2-0-public-application.md)

> [card] [OAuth 2.0 (Internal Application) · Link Account](https://docs.stackone.com/connectors/egnyte/guides/link-account/oauth-2-0-internal-application.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

Egnyte.filesystem

Egnyte.group

Egnyte.link

Egnyte.permission

Egnyte.user

No scopes found

38 actions

ActionDescriptionRequired scopes

Add Comment`egnyte_add_comment`

Add a comment (note) to a file or folder in Egnyte, identified by its absolute path.

`Egnyte.filesystem`

List Comments`egnyte_list_comments`

List comments associated with a file or folder. Filter by path, ISO 8601 time window, and paginate with offset/count.

`Egnyte.filesystem`

Get Comment`egnyte_get_comment`

Retrieve the details of a single comment by its UUID.

`Egnyte.filesystem`

Delete Comment`egnyte_delete_comment`

Delete a comment identified by its UUID.

`Egnyte.filesystem`

Get Events Cursor`egnyte_get_events_cursor_v1`

Fetch the current event stream cursor for this Egnyte tenant. Returns the latest and oldest event IDs along with a times...

`Egnyte.filesystem`

List Events (v2)`egnyte_get_events_v2`

Poll the Egnyte event stream for file system, note, and permission changes starting after a given cursor ID. Wait at lea...

`Egnyte.filesystem`

Get File Or Folder Metadata (v2)`egnyte_get_fs_v2`

Retrieve metadata for a file or folder at the given Egnyte path. Optionally list folder contents, include permissions, l...

`Egnyte.filesystem`

File Or Folder Operation (v2)`egnyte_post_fs_v2`

Perform a filesystem operation on a file or folder at the given path — create a folder, move, copy, rename, lock, or unl...

`Egnyte.filesystem`

Delete File Or Folder (v2)`egnyte_delete_fs_v2`

Delete a file or folder at the given path. Optionally scope deletion to a single file version via `entry_id`.

`Egnyte.filesystem`

Get File Or Folder Metadata By ID`egnyte_get_fs_by_id_v1`

Retrieve metadata for a file or folder using its persistent ID (group\_id for files, folder\_id for folders).

`Egnyte.filesystem`

File Or Folder Operation By ID`egnyte_post_fs_by_id_v1`

Move or copy a file or folder identified by its persistent ID (group\_id / folder\_id).

`Egnyte.filesystem`

Delete File Or Folder By ID`egnyte_delete_fs_by_id_v1`

Delete a file or folder identified by its persistent ID (group\_id / folder\_id). Optionally scope deletion to a single fi...

`Egnyte.filesystem`

Get Folder Statistics By ID`egnyte_get_fs_folder_stats_v1`

Retrieve aggregate statistics (item counts, sizes) for a folder identified by its folder\_id.

`Egnyte.filesystem`

Download File Content By Path`egnyte_get_fs_content_by_path_v1`

Download the binary content of a file at the given Egnyte path. Optionally scope the download to a specific file version...

`Egnyte.filesystem`

Upload File Content By Path`egnyte_post_fs_content_by_path_v1`

Upload a file's binary content to the given Egnyte path. Creates the file if it does not exist; overwrites it if it does...

`Egnyte.filesystem`

Download File Content By ID`egnyte_get_fs_content_by_id_v1`

Download the binary content of a file identified by its persistent group\_id. Optionally scope the download to a specific...

`Egnyte.filesystem`

Chunked Upload By File ID`egnyte_post_fs_content_chunked_by_id_v1`

Upload a single chunk of a large file (identified by its persistent group\_id) as part of a chunked upload. Recommended c...

`Egnyte.filesystem`

Modify Folder Options`egnyte_patch_folder_options_v1`

Update folder-level configuration such as description, link behaviour, move/delete restrictions, permission inheritance,...

`Egnyte.filesystem`

List Groups`egnyte_get_groups_v2`

List groups on the Egnyte domain. Supports SCIM-style filter syntax on displayName and paginates via startIndex/count.

`Egnyte.group`

Create Group`egnyte_post_groups_v2`

Create a new group on the Egnyte domain with the given displayName and initial member list.

`Egnyte.group`

Get Group`egnyte_get_groups_by_id_v2`

Retrieve the details of a group by its groupId, including its displayName and member list.

`Egnyte.group`

Replace Group`egnyte_put_groups_by_id_v2`

Fully replace a group — set its displayName and the complete member roster in one call. Any existing member NOT in the s...

`Egnyte.group`

Partially Update Group`egnyte_patch_groups_by_id_v2`

Partially update a group — rename via `displayName` or remove members incrementally via a `members` array of \`\{value, op...

`Egnyte.group`

Delete Group`egnyte_delete_groups_by_id_v2`

Delete a group by its groupId.

`Egnyte.group`

List Links (v2)`egnyte_get_links_v2`

List shareable file and folder links on the domain. Filter by path, username, link type, or accessibility. Paginate with...

`Egnyte.link`

Create Link (v1)`egnyte_post_links_v1`

Create a shareable file, folder, or upload link for a given path. Configure accessibility (anyone / password / domain /...

`Egnyte.link`

Get Link (v1)`egnyte_get_links_by_id_v1`

Retrieve the details of a shareable link by its linkId.

`Egnyte.link`

Delete Link (v1)`egnyte_delete_links_by_id_v1`

Delete a shareable link by its linkId.

`Egnyte.link`

Get Effective Permissions For User`egnyte_get_effective_permissions_for_user`

Retrieve the effective folder permissions for a specific user on a specific folder path. Both `username` and `folder` ar...

`Egnyte.permission`

Search Files And Folders (v2)`egnyte_search_v2_post`

Search for files and folders across the Egnyte domain using keywords and/or custom metadata filters. Supports pagination...

`Egnyte.filesystem`

Get User Info`egnyte_get_userinfo`

Return basic information (username, email, first\_name, last\_name, phone, is\_admin, is\_service\_account) about the user as...

`Egnyte.filesystem`

Restore Or Purge Trash Items`egnyte_trash_action`

Restore items from the Egnyte trash back to their original location, or permanently delete (purge) them. Provide the act...

`Egnyte.filesystem`

List Trash Contents (v2)`egnyte_list_trash_v2`

List items in the Egnyte trash with extended sort options and a deletedBy/date-range filter. Only administrators or powe...

`Egnyte.filesystem`

List Users`egnyte_list_users`

List users on the Egnyte domain. Supports SCIM-style filter expressions, 1-based startIndex pagination, and count up to...

`Egnyte.user`

Create User`egnyte_create_user`

Create a new user on the Egnyte domain. Requires userName, email, name (givenName + familyName), active flag, authType,...

`Egnyte.user`

Get User`egnyte_get_user`

Retrieve a single Egnyte user by their numeric user ID.

`Egnyte.user`

Update User`egnyte_update_user`

Partially update an Egnyte user. Any subset of email, name (givenName/familyName), active, authType, userType, and other...

`Egnyte.user`

Delete User`egnyte_delete_user`

Delete an Egnyte user by their numeric user ID.

`Egnyte.user`

## Events

Tags

Select all
|
Clear

Comments

Files and Folders

Groups

Links

Webhooks

No tags found

21 events

EventDescriptionTags

File Added Webhook`egnyte_webhook_fs_add_file`

Fires when a file (or new version) is uploaded to a monitored folder.

Files and FoldersWebhooks

Folder Added Webhook`egnyte_webhook_fs_add_folder`

Fires when a folder is created in a monitored path.

Files and FoldersWebhooks

File Copied Webhook`egnyte_webhook_fs_copy_file`

Fires when a file is copied into a monitored folder.

Files and FoldersWebhooks

Folder Copied Webhook`egnyte_webhook_fs_copy_folder`

Fires when a folder is copied into a monitored path.

Files and FoldersWebhooks

File Moved Webhook`egnyte_webhook_fs_move_file`

Fires when a file is moved or renamed inside a monitored folder.

Files and FoldersWebhooks

Folder Moved Webhook`egnyte_webhook_fs_move_folder`

Fires when a folder is moved or renamed inside a monitored path.

Files and FoldersWebhooks

File Deleted Webhook`egnyte_webhook_fs_delete_file`

Fires when a file is deleted from a monitored folder.

Files and FoldersWebhooks

Folder Deleted Webhook`egnyte_webhook_fs_delete_folder`

Fires when a folder is deleted from a monitored path.

Files and FoldersWebhooks

Trash Item Permanently Deleted Webhook`egnyte_webhook_fs_delete_from_trash`

Fires when a file or folder is permanently removed from trash.

Files and FoldersWebhooks

Trash Item Restored Webhook`egnyte_webhook_fs_restore_from_trash`

Fires when a file or folder is restored from trash.

Files and FoldersWebhooks

Download Link Created Webhook`egnyte_webhook_link_create_download_link`

Fires when a file or folder download share link is created.

LinksWebhooks

Upload Link Created Webhook`egnyte_webhook_link_create_upload_link`

Fires when a public upload link is created.

LinksWebhooks

Download Link Deleted Webhook`egnyte_webhook_link_delete_download_link`

Fires when a file or folder download link is deleted.

LinksWebhooks

Upload Link Deleted Webhook`egnyte_webhook_link_delete_upload_link`

Fires when a public upload link is deleted.

LinksWebhooks

Comment Added Webhook`egnyte_webhook_comment_set_comment`

Fires when a note is added to a file or folder.

CommentsWebhooks

Comment Removed Webhook`egnyte_webhook_comment_remove_comment`

Fires when a note is removed from a file or folder.

CommentsWebhooks

Group Created Webhook`egnyte_webhook_group_create`

Fires when a new group is created on the domain.

GroupsWebhooks

Group Deleted Webhook`egnyte_webhook_group_delete`

Fires when a group is deleted from the domain.

GroupsWebhooks

Group Renamed Webhook`egnyte_webhook_group_rename`

Fires when a group's name is changed.

GroupsWebhooks

Group Members Added Webhook`egnyte_webhook_group_add_members`

Fires when one or more users are added to a group.

GroupsWebhooks

Group Members Removed Webhook`egnyte_webhook_group_remove_members`

Fires when one or more users are removed from a group.

GroupsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.