Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node integrates with the Outline knowledge base API to manage collections and their permissions. Specifically, the "Add Group" operation under the "Collection" resource allows you to add a group to a collection with a specified permission level. This is useful for managing access control in collaborative documentation environments where groups of users need shared access to certain collections.

Practical examples include:

  • Granting a team or department group read-only or read-write access to a specific collection of documents.
  • Automating permission assignments when new groups are created or collections are updated.
  • Managing access rights programmatically as part of a larger workflow involving document management.

Properties

Name Meaning
Collection ID The unique identifier of the collection to which the group will be added.
Group ID The unique identifier of the group to add to the collection.
Permission The permission level to grant the group on the collection. Options: "Read", "Read & Write".

Output

The node outputs JSON data representing the response from the Outline API after adding the group to the collection. This typically includes details about the updated collection-group relationship or confirmation of the action.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Collection ID or Group ID parameters will cause the API request to fail.
    • Insufficient permissions on the API key may prevent adding groups to collections.
    • Network connectivity problems can cause request timeouts or failures.

  • Error messages:

    • Errors returned by 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 Group ID are correct and exist in your Outline instance.
    • Ensure the API key used has sufficient privileges to modify collection memberships.
    • Check network connectivity and retry if transient errors occur.

Links and References

Discussion