Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node integrates with the Outline knowledge base API, allowing users to perform various operations on different resources such as documents, collections, users, groups, comments, attachments, and more. Specifically, for the Document resource with the Get Users operation, it retrieves the list of users who have access to a specified document.

Common scenarios where this node is beneficial include:

  • Managing user permissions and access control for documents in an Outline knowledge base.
  • Automating workflows that require fetching document collaborators or contributors.
  • Integrating document user data into other systems for reporting or auditing purposes.

Practical example:

  • You want to get all users who can access a particular document to notify them about an update or changes made to the document.

Properties

Name Meaning
Document ID The unique identifier of the document for which you want to retrieve the users.

Output

The output is a JSON object containing the response from the Outline API endpoint /documents.users. This typically includes a list of users who have access to the specified document, along with their details such as user IDs, names, email addresses, and permission levels.

If multiple input items are processed, the output will be an array of such JSON objects, each corresponding to one 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 via HTTP POST requests.
  • No additional external dependencies beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Document ID: The API call will fail if the Document ID is not provided or incorrect.
    • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
    • Network or API downtime: Temporary connectivity issues may cause request failures.

  • Error messages:

    • Errors returned by the Outline API will be passed through, often indicating issues like "document not found" or "unauthorized".
    • If the node is set to continue on failure, error messages will appear in the output JSON under an error field.

  • Resolution tips:

    • Verify the Document ID is correct and exists in your Outline instance.
    • Check API credentials and permissions.
    • Review network connectivity and retry if necessary.

Links and References

Discussion