Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base API to manage documents and their users. Specifically, the "Remove User" operation under the "Document" resource removes a specified user’s access from a given document. This is useful in scenarios where you want to revoke a user's permissions or membership on a document, for example, when a team member leaves a project or should no longer have access to sensitive information.

Practical examples:

  • Removing a collaborator who no longer needs access to a confidential document.
  • Automating user access management by removing users from documents based on role changes.
  • Cleaning up document memberships as part of a workflow that manages document lifecycle.

Properties

Name Meaning
Document ID The unique identifier of the document from which the user will be removed.
User ID The unique identifier of the user to remove from the document's access list.

Output

The output JSON contains the response from the Outline API after attempting to remove the user from the document. Typically, this will include confirmation of the removal or details about the updated document membership state. If multiple items are processed, the output is an array of such responses paired with the input item index.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Outline knowledge base API.
  • The node uses an internal helper function to make HTTP POST requests to the Outline API endpoints.
  • No additional external dependencies beyond the Outline API and its authentication 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 user removal.
    • Network or API downtime can cause request failures.

  • Error messages:

    • Errors returned from the Outline API will be passed through in the output JSON under an error field if "Continue On Fail" is enabled.
    • Typical error messages might include "User not found", "Document not found", or "Permission denied".

  • 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 Outline service status.

Links and References

Discussion