Custom URL Protocol

URL_SCHEME is the tenant name in lowercase (e.g. idgard).

idgard Sync registers a custom URL protocol (URL_SCHEME://) that allows you to trigger application actions directly from links in emails, web pages, or other applications. When the protocol handler is registered, clicking a URL_SCHEME:// link launches the idgard Sync CLI tool idgard-cli.exe and executes the corresponding command.

Activation

The custom URL protocol handler is disabled by default. It can be enabled via the CustomUrlProtocolEnabled setting in the application configuration. When enabled, the application registers the URL_SCHEME:// scheme in the Windows Registry under HKEY_CURRENT_USER — no administrator privileges are required.

URL Format

URL_SCHEME://<command>[/<primary>][?<key>=<value>&<keyN>=<valueN>]

<command> — The action to execute (see commands below).
/<primary> — An optional path segment that maps to the command's primary option.
?<key>=<value> — Optional query parameters that map to CLI options by name. The ? prefix marks the start of the query string and is required before the first parameter.
&<keyN>=<valueN> — Additional query parameters, separated by &. Multiple parameters can be chained this way.

Note

The scheme prefix is always URL_SCHEME://. Path values and query parameters are URL-encoded.

Common URL Encodings

Character	Encoded	Description
Space	`%20`	Used in folder or file names containing spaces.
`:`	`%3A`	Colon — appears after the drive letter (e.g. `C%3A`).
`\`	`%5C`	Backslash — Windows path separator.
`/`	`%2F`	Forward slash — alternative path separator.
`?`	`%3F`	Question mark — must be encoded inside path segments.
`&`	`%26`	Ampersand — must be encoded inside query parameter values.
`=`	`%3D`	Equals sign — must be encoded inside query parameter values.

Available Commands

Reveal in Explorer (`_reveal`)

Opens Windows Explorer at the specified path. If the path points to a file, the file is selected in its parent folder. Omitting the path opens the sync-root folder.

Parameter	CLI Option	Description
path (optional)	`--path`	Absolute path or path relative to the sync-root folder.

Examples:

<!-- Opens the sync-root folder in Windows Explorer -->
URL_SCHEME://_reveal

<!-- Opens Windows Explorer with C:\Users\me\Documents\report.pdf selected (absolute path) -->
URL_SCHEME://_reveal/C%3A%5CUsers%5Cme%5CDocuments%5Creport.pdf

<!-- Opens Windows Explorer at MyBox\report.pdf relative to the sync-root folder -->
URL_SCHEME://_reveal/MyBox%5Creport.pdf

Real Examples:

Reveal sync-root folder in Windows Explorer.
Reveal Getting Started.pdf in Windows Explorer.

Open in Web (`_nav`)

TENANT_NAME is "idgard".

Opens a idgard item in the web frontend using the system's default browser.

Parameter	CLI Option	Description
id	`--id`	The idgard item ID.
hostname	`--hostname`	The idgard server hostname (e.g. `TENANT_NAME`).
user-id	`--user-id`	The idgard user ID.
action (optional)	`--action`	The action to perform: `NavigateTo` (default) or `Settings`.