Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base API to manage collections and their users. Specifically, the "Add User" operation for the "Collection" resource allows you to add a user to a specified collection with a defined permission level. This is useful in scenarios where you want to programmatically control access to knowledge base collections by granting users read or read-write permissions.

Practical examples include:

  • Automating onboarding processes by adding new team members to relevant collections.
  • Managing user permissions dynamically based on roles or project assignments.
  • Integrating with other systems to synchronize user access rights in Outline collections.

Properties

Name Meaning
Collection ID The unique identifier of the collection to which the user will be added.
User ID The unique identifier of the user to add to the collection.
Permission The permission level granted to the user. Options: "Read" (read-only), "Read & Write".

Output

The output JSON contains the response from the Outline API after attempting to add the user to the collection. It typically includes details about the updated collection membership or confirmation of the addition. The exact structure depends on the Outline API's response but generally confirms success or provides error information.

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, specifically /collections.add_user.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

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

  • Error messages:

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

  • Resolutions:

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

Links and References

Discussion