Configure help links allowlist
  • 23 Aug 2023
  • 1 Minute to read
  • Dark
    Light

Configure help links allowlist

  • Dark
    Light

Article summary

To enable users to add help links from worksheets to Zilliant documentation or resources published to other locations, you must add their base URLs to an allowlist.

Important

Only users with Admin and Creator roles can configure and edit the allowlist.

Configure the allowlist

  1. Run a PATCH request to the /api/v3/organization/settings endpoint for your tenant.
  2. Add a raw JSON document body with allowed sites. Use the following syntax:
    • allowedExternalLinks—Array of the allowed URLs.
    Tip
    • You must add at least one link.
    • Links must start with http:// or https://.
    • Links must end with ?, /, or #.

Note: When you add to the allowlist a base URL (domain name), all URLs from the specified domain are allowed. For example, if you add https://docs.zilliant.com/, users can also enable on worksheets such help links as https://docs.zilliant.com/docs/iq-platform and https://docs.zilliant.com/docs/workbooks.

Example JSON body

{
    "allowedExternalLinks": [
        "https://docs.zilliant.com/",
        "http://www.customerdocssite.com?",
        "http://www.customerdocssite.com#"
    ]
}

Edit the allowlist

You can edit, add, or delete URLs in the allowlist. To do this:

  1. Run a PATCH request as described above.
  2. Make changes to the allowedExternalLinks values.

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.