outline icon

outline

Interact with outline API

Actions107

Documents → Documents Memberships

AI-generated

Summary

Manage document memberships in Outline by specifying a document ID, optional user name filter, and permission level (read or read_write). Request options include configurable batching throttling and proxy/timeout settings.

Inputs

  • id (required) — Unique identifier for the document. Either the UUID or the urlId is acceptable.
  • query — If set, will filter the results by user name.
  • permission — Permission level for the membership. Options: Read (read) or Read Write (read_write).
  • requestOptions — Configure request options including batching throttle settings (items per batch and batch interval in ms).
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible.
  • proxy — HTTP proxy to use. If authentication is required it can be defined as: http://username:password@myproxy:3128
  • timeout — Time in ms to wait for the server to send response headers before aborting the request.

Output shape

main

Outputs are not explicitly detailed in the provided source or properties; standard n8n main output is expected.

Examples

Example 1: Add read access membership for a document

Set id to the target document's UUID or urlId, leave query empty, set permission to 'read', and enable default timeout.

Links

Discussion