Skip to main content
Egnyte logo
  • Category: file management & storage
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 60
  • Triggers: 0
  • Slug: EGNYTE
  • Version: 20261101_00

Tools

Slug: EGNYTE_CREATE_AUDIT_PERMISSIONSTool to generate a permissions audit report for specified date range and filters. Use when you need to create an audit report for permissions changes and retrieve a report ID for async retrieval.

Input Parameters

string ("json" | "csv")
required
Output format. Must be either ‘json’ or ‘csv’.
array
Folder paths to include in the report.
string
required
Final day the report should cover. Format: YYYY-MM-DD.
array
Users who assigned permissions to include in the report.
string
required
Initial day the report should cover. Format: YYYY-MM-DD.
array
Individual users to include in the report.
array
Groups to include in the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_AUDIT_USERSTool to create a user audit report in Egnyte. Use when you need to generate an audit report of user-related actions within a specific date range. The report is generated asynchronously - use the returned job ID to poll for completion.

Input Parameters

string ("json" | "csv")
Enum for audit report format.
array
Array of user email addresses to filter the audit report. Only actions related to these users will be included. If not specified, all users are included.
string
End date for the audit report in ISO 8601 format (YYYY-MM-DD). Example: ‘2026-02-12’. If not specified, the report will include data up to the current date.
string
Start date for the audit report in ISO 8601 format (YYYY-MM-DD). Example: ‘2026-01-01’. If not specified, the report will include all available historical data.
array
Array of user action types to filter the audit report. Supported actions include CREATE, PASSWORD_RESET, PASSWORD_CHANGE, UPDATE, DELETE, DISABLE, ENABLE, LOGIN, LOGOUT. If not specified, all action types are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_BOOKMARKTool to create a bookmark on a folder using either path or folder_id. Use when you need to add a folder to user bookmarks for quick access.

Input Parameters

string
Full path to the folder to bookmark. Must start with ’/’ and reference an existing folder. Use this OR folder_id, not both.
string
UUID of the folder to bookmark. Use this OR path, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_COMMENTTool to create a new comment/note on a file in Egnyte. Use when you need to add comments, notes, or feedback to a specific file.

Input Parameters

string
required
The comment text content to add to the file. Plain text or formatted content.
string
required
Full path to the file in Egnyte file system (e.g., ‘/Shared/Documents/test.txt’). Must include leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_FILE_AUDIT_REPORTCreate a file activity audit report for a specified date range and optional filters. The response may contain a job ID for asynchronous retrieval or raw CSV data.

Input Parameters

array
Filter by specific usernames. Only file activities by these users will be included. If not specified, all users are included.
string ("json" | "csv")
required
Output format for the report. Must be either ‘json’ or ‘csv’.
array
Filter by specific folder paths. Only file activities in these folders will be included. Paths should be relative to the root.
string
required
End date for the report in YYYY-MM-DD format. The report will include file activities up to and including this date.
string
required
Start date for the report in YYYY-MM-DD format. The report will include file activities from this date onwards.
array
Filter by specific transaction types (download, preview, upload, delete, move, copy, rename). If not specified, all transaction types are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_GROUPTool to create a new group with display name and members. Use when you need to add a new group to the Egnyte domain. SCIM-compliant.

Input Parameters

array
required
Array of member objects with user IDs. Each member is specified by their user ID. This is a required field.
string
required
Display name for the new group. This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_LOGIN_AUDIT_REPORTTool to generate a login audit report for specified date range and filters. Use when you need to create an audit report for login activity and retrieve a report ID for async retrieval.

Input Parameters

array
Filter by usernames. If not specified, all users are included.
array
Filter by event types (e.g., ‘logins’, ‘failed_attempts’). If not specified, all event types are included.
string ("json" | "csv")
required
Output format. Must be either ‘json’ or ‘csv’.
string
required
Final day the report should cover. Format: YYYY-MM-DD.
string
required
Initial day the report should cover. Format: YYYY-MM-DD.
array
Filter by access points (e.g., ‘web’, ‘ftp’, ‘mobile’). If not specified, all access points are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_CREATE_USERTool to create a new user in the Egnyte domain. Use when you need to add a new user account with specified authentication type and user type. SCIM-compliant endpoint.

Input Parameters

object
required
User’s name information including first name and last name.
string
User’s role in the organization. Optional.
string
required
Email address for the user. Must be a valid email format.
boolean
required
Whether the user account should be active (true) or inactive (false).
string ("egnyte" | "sso" | "ad")
required
Authentication method: ‘egnyte’ (Egnyte native authentication), ‘sso’ (Single Sign-On), or ‘ad’ (Active Directory).
string
required
Username for the new user. Must be unique within the domain.
string ("admin" | "power" | "standard")
required
Type of user account: ‘admin’ (full administrative access), ‘power’ (advanced user with additional permissions), or ‘standard’ (regular user).
string
External identifier for the user (e.g., from Active Directory or another system). Optional.
boolean
Whether to send an invitation email to the user. Optional. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_AUDIT_REPORTTool to delete an audit report from Egnyte. Use when you need to remove a specific audit report by its type and ID.

Input Parameters

string
required
The unique ID of the audit report to delete.
string ("logins" | "files" | "permissions" | "users" | "groups" | "workgroup-settings")
required
Type of audit report to delete. Must be one of: logins, files, permissions, users, groups, workgroup-settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_BOOKMARKTool to delete a bookmark from the user’s bookmarks. Use when you need to remove a specific bookmark by its ID.

Input Parameters

string
required
The unique identifier of the bookmark to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_FILE_BY_IDDelete a file using persistent file ID. Can specify entry_id to delete specific version. Use when you need to delete a file by its persistent identifier (Group ID) rather than path.

Input Parameters

string
Optional entry ID to delete a specific version of the file. If not provided, the entire file is deleted.
string
required
Persistent file identifier (Group ID) of the file to delete. This is the unique identifier that persists across file moves and renames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_FILE_OR_FOLDERTool to delete a file or folder at the specified path. Items are moved to trash, not permanently deleted. Use when you need to remove a file or folder from the Egnyte file system.

Input Parameters

string
required
Full path to the file or folder to delete (e.g., ‘Shared/Documents/file.txt’). Each path element will be URL encoded automatically.
string
Optional entry ID to delete a specific version of the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_GROUPTool to delete a group from the Egnyte domain. Use when you need to permanently remove a group. SCIM-compliant.

Input Parameters

string
required
The unique identifier (UUID) of the group to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_METADATA_KEYTool to delete a metadata key from a namespace. Use force_delete=true to remove keys that are currently in use.

Input Parameters

string
required
Name of the metadata key to delete from the namespace
boolean
Set to true to force delete the key even if it is in use. If false and key is in use, deletion will fail.
string
required
Namespace identifier containing the metadata key to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_METADATA_NAMESPACETool to delete a metadata namespace. Use force_delete=true to remove namespaces that are currently in use. Returns 403 error if the namespace is in use and force_delete is false.

Input Parameters

boolean
Set to true to force delete the namespace even if it is in use. If false and namespace is in use, deletion will fail.
string
required
Namespace identifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_NOTETool to delete a note/comment in Egnyte by its UUID. Use when you need to remove a comment from a file or folder.

Input Parameters

string
required
The unique identifier (UUID) of the note/comment to delete. Example: ‘2b42508b-5c8b-41ad-8f23-0d48ea97cbfd’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DELETE_USERTool to delete a user from the Egnyte domain using the SCIM-compliant endpoint. Use when you need to permanently remove a user from the system. This action is destructive and cannot be undone.

Input Parameters

string
required
The unique identifier of the user to delete from the Egnyte domain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DOWNLOAD_FILETool to download file content from a specified path in Egnyte. Use when you need to retrieve the contents of a file stored in the Egnyte file system. Supports downloading specific versions via entry_id and partial content via Range header.

Input Parameters

string
required
Full path to the file in Egnyte file system (e.g., ‘Shared/Documents/test.txt’). Path should NOT start with a leading slash.
string
Optional entry ID to download a specific version of the file. If not provided, downloads the latest version.
string
Optional HTTP Range header value for partial content download (e.g., ‘bytes=0-1023’ to download first 1024 bytes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_DOWNLOAD_FILE_BY_IDTool to download file content using persistent file ID from Egnyte. Use when you need to retrieve file content by its unique group_id. Optionally specify entry_id to download a specific version of the file.

Input Parameters

string
Specific version identifier. If provided, downloads a specific version of the file instead of the latest version.
string
required
Persistent file identifier (group_id) used to uniquely identify the file in Egnyte.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_AUDITTool to retrieve an audit report by type and ID. Audit reports are generated asynchronously - first create a report using POST /pubapi/v1/audit/{type}, then use this action to retrieve the completed report data. Returns audit events in JSON format.

Input Parameters

integer
required
Report ID obtained from creating an audit report via POST request. This is the unique identifier returned when the report was generated.
string ("logins" | "files" | "permissions" | "users" | "groups" | "workgroup-settings")
required
Type of audit report. Valid values: logins, files, permissions, users, groups, workgroup-settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_AUDIT_JOBTool to check the status of an audit report generation job. Use when you need to poll the status of a previously created audit report to determine if it’s ready for download.

Input Parameters

string
required
The job ID returned from creating an audit report (e.g., from POST /pubapi/v1/audit/files). This ID is used to check the status of the audit report generation job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_AUDIT_STREAMStream audit events in JSON format starting from a specific date, with up to 5,000 events for at most 30-minute spans and audit logs from the last 7 days. Use the returned nextCursor for subsequent requests.

Input Parameters

string
Cursor for pagination. Use the nextCursor value from a previous response to get the next set of events.
string ("json" | "csv")
Format for audit stream response.
string
Start date for audit events in ISO 8601 format (e.g., ‘2026-02-10T00:00:00Z’). If not provided, returns events from the current time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_BOOKMARKTool to retrieve details for a specific bookmark by its ID. Use when you need to get the path, folder_id, or creation date of a bookmarked folder.

Input Parameters

string
required
The unique identifier of the bookmark to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_EVENTS_CURSORTool to get the latest event cursor position for starting event polling. Use this to obtain the current cursor before beginning to poll for events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_EVENTS_V2Poll v2 events after a cursor ID, including permission_change, file_system, and note events. If the API returns 204, the tool returns an empty event list with count zero.

Input Parameters

integer
required
Cursor ID to get events after. Use the latest_id from a previous response or get the current cursor from /pubapi/v1/events/cursor endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_FILE_BY_IDTool to retrieve file metadata using persistent file ID (group_id) instead of path. Use when you need to access file details regardless of the file’s current location or name changes.

Input Parameters

string
required
Persistent file identifier (UUID format). This ID remains constant across file versions and can be used to reference the file regardless of its path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_FILE_METADATATool to get file or folder metadata from Egnyte. Use when you need to retrieve properties like name, path, size, last modified date, type, and other metadata. For folders, optionally list contents with pagination and sorting.

Input Parameters

string
required
Full path to the file or folder. Should start with ’/’. Example: ‘/Shared/Documents/file.txt’ or ‘/Shared/MyFolder’
integer
Number of items to return in folder listing. Only applicable when list_content=true.
integer
Starting index for pagination of folder contents. Only applicable when list_content=true.
string ("name" | "last_modified" | "size")
Sort field options for folder contents.
boolean
Whether to list folder contents. Only applicable for folders. If true, returns folders and files arrays.
string ("ascending" | "descending")
Sort direction options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_FILE_METADATA_VALUESTool to retrieve custom metadata values for a file or file version within a specific namespace. Use when you need to fetch custom properties associated with a file.

Input Parameters

string
required
File group_id or entry_id. This is the unique identifier for the file.
string
required
Namespace identifier. The name of the custom metadata namespace to retrieve properties from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_FOLDER_BY_IDRetrieve folder metadata by persistent folder ID, including available name, path, contents, and link-sharing settings.

Input Parameters

string
required
Persistent folder identifier (UUID format). This ID remains constant even if the folder is moved or renamed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_FS_STATSTool to get statistics for a folder by ID including file counts, folder counts, and size information. Use when you need to retrieve storage and content metrics for a specific folder.

Input Parameters

string
required
The persistent folder ID (folder_id) to get statistics for. This is a UUID-like identifier for the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_GROUPTool to retrieve details for a specific group including members and attributes. Use when you need to fetch group information by group ID. SCIM-compliant.

Input Parameters

string
required
The unique identifier (UUID) of the group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_PERMISSIONSTool to get effective permissions for a folder including users and groups with their permission levels. Use when you need to check who has access to a specific folder and their permission levels (Owner, Full, Editor, Viewer, None).

Input Parameters

string
required
Folder path to get permissions for. Example: ‘Shared’ or ‘Shared/Documents’
string
Filter by specific usernames (pipe-separated list). Example: ‘jsmith|ajones’
string
Filter by specific group names (pipe-separated list). Example: ‘All Power Users|Engineering’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_USERTool to retrieve details for a single user by ID. Use when you need to fetch specific user information using their user ID. SCIM-compliant endpoint.

Input Parameters

integer
required
The unique identifier of the user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_GET_USERINFOTool to get information about the currently authenticated user. Use when you need to retrieve details about the user associated with the OAuth token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_BOOKMARKSTool to list all bookmarked folders for the authenticated user with pagination support. Use when you need to retrieve user bookmarks or check which folders are bookmarked.

Input Parameters

integer
Number of bookmarks to return per page. Use for controlling page size in pagination.
integer
Starting index for pagination. Use to skip the first N bookmarks in the result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_COMMENTSList comments or notes on a specific file in Egnyte, with pagination support for retrieving additional results.

Input Parameters

string
required
Full path to the file in Egnyte file system (e.g., ‘/Shared/Documents/test.txt’). Must include leading slash.
integer
Maximum number of comments to return in the response. Use for pagination.
integer
Starting index for pagination. Use to skip the first N comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_GROUPSList custom groups in the Egnyte domain, with optional filtering and pagination. Default Egnyte groups are not included.

Input Parameters

integer
The number of results to return per page. Use to control page size in paginated responses.
string
SCIM filter expression to filter groups by attributes. Supports SCIM filtering syntax for querying specific groups.
integer
The 1-based index of the first result to return. Use for pagination to specify where to start in the result set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_INSIGHTS_FILESTool to list recently accessed files for the authenticated user. Returns up to 10 files with metadata including size, last_modified, and last_accessed timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_METADATA_NAMESPACESTool to list all custom metadata keys in a namespace. Use when you need to inspect metadata key definitions for a specific namespace in Egnyte.

Input Parameters

string
required
Namespace identifier to retrieve metadata keys from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_USERSTool to retrieve all users or a filtered subset from the Egnyte domain. Use when you need to list users with optional pagination and filtering via SCIM-compliant parameters.

Input Parameters

integer
The number of results to return per page. Used to control page size.
string
Filter expression to retrieve a subset of users. Supports SCIM filtering (e.g., ‘userName eq “jsmith”’ or ‘email co “@example.com”’). Attribute names are case insensitive.
string
Comma-separated list of attribute names to return in the response. If not specified, all attributes are returned.
integer
The 1-based index of the first result to return. Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_WORKFLOWSTool to list all workflows in Egnyte. Use when you need to retrieve the list of workflows configured in the Egnyte account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LIST_WORKFLOWS_TASKSTool to list all workflow tasks. Returns an array of tasks with total count. Use when you need to retrieve all workflow tasks in the Egnyte system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_LOCK_FILETool to lock a file to prevent edits by other users. Use when you need to acquire an exclusive lock on a file to prevent concurrent modifications.

Input Parameters

string
required
Full path to the file to lock in the Egnyte file system. Path should NOT start with a leading slash. Example: ‘Shared/Documents/test_file.txt’
string
A string identifier for the lock. This token can be used to identify the lock owner and is required to unlock the file later.
integer
The timeout duration in seconds after which the lock will automatically expire. Example: 7200 for 2 hours, 3600 for 1 hour.
string
Optional base64-encoded string containing collaboration metadata. This field is used for storing additional collaboration context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_REPLACE_GROUPTool to fully replace a group’s attributes including display name and members. Use when you need to completely overwrite all group properties. This uses PUT method and replaces all attributes.

Input Parameters

string
required
The unique identifier (UUID) of the group to replace.
array
required
Complete list of members for the group. Each member is specified by their numeric user ID. This replaces the entire member list.
string
required
The display name for the group. This field is required for PUT operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_SEARCH_V2Tool to perform advanced search with custom metadata filtering in Egnyte using v2 API. Use when you need to search files and folders with metadata filters or namespace constraints. Results scoped to user permissions.

Input Parameters

string
Filter results by type. Use ‘file’ for files only or ‘folder’ for folders only.
integer
Number of results to return per page. Maximum offset + count is 10000.
string
required
Search query string to find files and folders based on text content, metadata, and filenames
string
Folder path to limit search scope. Only files within this folder and its subfolders will be searched.
integer
Starting index for pagination. Use to skip the first N results. Maximum offset + count is 10000.
array
Array of metadata namespace names to filter results. Only items with metadata in these namespaces will be returned.
array
Array of custom metadata filters. Each filter specifies namespace, key, operator, and value for advanced metadata-based searching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_SET_FILE_METADATA_VALUESTool to set custom metadata values for a file or file version within a specific namespace. Use when you need to add or update custom properties on a file. Keys must already exist in the namespace.

Input Parameters

string
required
File group_id for latest version or entry_id for specific version. This is the unique identifier for the file.
object
required
Dictionary of custom metadata property key-value pairs to set. Keys must already be defined in the namespace. Set a value to null to remove that metadata value.
string
required
Namespace identifier. The name of the custom metadata namespace where properties will be set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_SET_FOLDER_METADATA_VALUESTool to set custom metadata values for a folder within a namespace. Use when you need to assign or update custom properties on a folder in Egnyte.

Input Parameters

string
required
Folder identifier. This is the unique identifier for the folder.
string
required
Namespace identifier. The name of the custom metadata namespace to set properties for.
object
required
Dictionary of custom metadata property key-value pairs to set within the namespace. Each key must correspond to a metadata key defined in the namespace. Values can be strings, integers, floats, or booleans depending on the metadata key type definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_SET_PERMISSIONSTool to set folder permissions for users or groups. Permission levels: Owner, Full, Editor, Viewer, None. Use when you need to grant or revoke access to a folder for specific users or groups.

Input Parameters

string
required
Folder path to set permissions for. Example: ‘Shared/Documents’ or ‘Shared’. Do not include leading slash.
array
Array of usernames to set permissions for. Either users or groups must be provided.
array
Array of group names to set permissions for. Either users or groups must be provided.
string ("Owner" | "Full" | "Editor" | "Viewer" | "None")
required
Permission level to assign. Must be one of: Owner, Full, Editor, Viewer, None.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_STREAM_AUDIT_EVENTSStream audit events from a start date or a previous cursor, optionally filtering by FILE_AUDIT, LOGIN_AUDIT, or PERMISSION_AUDIT. Returns up to 5,000 events per request.

Input Parameters

array
Array of audit types to filter by. If not specified, all audit types are returned. Options: FILE_AUDIT (file operations), LOGIN_AUDIT (login events), PERMISSION_AUDIT (permission changes).
string
ISO 8601 date to start streaming from. Format: YYYY-MM-DDTHH:MM:SSZ. Example: ‘2026-02-11T00:00:00Z’. Required if nextCursor is not provided. Must be within the last 7 days.
string
Cursor for pagination. Use the nextCursor value from a previous response to fetch the next batch of events. Mutually exclusive with startDate - provide either startDate or nextCursor, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_UPDATE_FOLDER_OPTIONSUpdate a folder’s description by path.

Input Parameters

string
required
Folder path to update. Example: ‘Shared’ or ‘Shared/Documents’. Do not include leading slash.
string
Description for the folder. Provide a descriptive text to explain the folder’s purpose or contents. Maximum 200 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_UPDATE_GROUPTool to update specific attributes of a group including display name and members. Use when you need to modify group properties or membership. SCIM-compliant endpoint for incremental updates.

Input Parameters

array
Updated list of members for the group. Each member is specified by their numeric user ID. This replaces the entire member list.
string
required
The unique identifier (UUID) of the group to update.
string
New display name for the group. Specify this to rename the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_UPDATE_METADATA_KEYTool to update key definitions including display name, help text, data values for enums, and priority. Use when you need to modify metadata key properties within a namespace.

Input Parameters

array
Array of allowed values for enum type keys. Only applicable when key type is ‘enum’
string
Data type of the metadata key (string, integer, decimal, enum, date)
string
Help text to provide guidance on how to use this metadata key (max 100 characters)
string
required
Name of the metadata key to update within the namespace
integer
Display priority for the metadata key. Higher values indicate higher priority
string
New display name for the metadata key
string
required
Namespace identifier containing the metadata key to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_UPDATE_METADATA_NAMESPACETool to update key definitions of a metadata namespace. Use when you need to change the display name or adjust field priorities. At least one of displayName or priorities must be provided.

Input Parameters

object
Object containing key-value pairs where keys are metadata field names and values are their priority numbers
string
New display name for the namespace
string
required
Namespace identifier to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_UPDATE_USERTool to update specific attributes of a user in the Egnyte domain using the SCIM-compliant endpoint. Use when you need to modify user information such as name, email, active status, or other user properties. Only the attributes provided in the request will be updated.

Input Parameters

string
required
The unique identifier of the user to update.
object
User’s name information for update.
string
User’s email address to update.
boolean
Whether the user account should be active or inactive.
string
Authentication type for the user.
string
Language preference for the user in ISO format (e.g., ‘en-US’, ‘de-DE’).
string
The Egnyte username. May have restrictions on modification depending on account configuration.
string
Type of user account in the system.
string
Identity provider user identifier.
string
Immutable unique identifier provided by the API consumer (e.g., Active Directory SID).
boolean
Whether to send an invitation email to the user after update.
string
User principal name (typically the same as email).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EGNYTE_UPLOAD_FILETool to upload or update a file at the specified path in Egnyte. Use when you need to create a new file or replace an existing file. For files larger than 100MB, consider using chunked upload instead.

Input Parameters

object
required
File to upload.
string
required
Full path including filename where the file should be uploaded (e.g., ‘Private/username/document.txt’, ‘Shared/Documents/report.pdf’). Path should NOT start with a leading slash.
string
Last modified timestamp in ISO8601 format (e.g., ‘2023-01-15T10:30:00Z’). If provided, sets the file’s last modified time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not