OutlineInstall

Overview

This node integrates with the Outline knowledge base API to manage documents and their permissions. Specifically, the "Add User" operation for the "Document" resource allows you to add a user to a document with a specified permission level (read or read & write). This is useful in scenarios where you want to programmatically control access to specific documents within your knowledge base, such as granting team members editing rights or read-only access.

Practical examples:

• Automatically grant a new team member read access to a set of documents when they join a project.
• Update document permissions in bulk based on role changes in your organization.
• Integrate with other systems to synchronize user access rights to documents.

Properties

Output

The output is a JSON object representing the response from the Outline API after adding the user to the document. It typically contains details about the updated document memberships or confirmation of the addition.

If multiple items are processed, the output is an array of such JSON objects, each paired with the corresponding input item.

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the Outline API.
• The node uses the Outline API endpoints, so network connectivity to the Outline service is necessary.
• No additional environment variables or configurations beyond the API credential are required.

Troubleshooting

• Common issues:

  • Invalid or missing Document ID or User ID parameters will cause the API request to fail.
  • Insufficient permissions of the API key may prevent adding users to documents.
  • Network connectivity issues can cause request failures.

• Error messages:

  • Errors returned by the Outline API will be passed through, often indicating invalid IDs or permission errors.
  • If the node is configured to continue on failure, error messages will appear in the output JSON under an error field.

• Resolutions:

  • Verify that the Document ID and User ID are correct and exist in the Outline system.
  • Ensure the API key has sufficient privileges to modify document memberships.
  • Check network connectivity and retry if transient errors occur.

Links and References

• Outline API Documentation
• Outline Knowledge Base