Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base API, allowing users to manage various resources such as collections, documents, groups, users, and more. Specifically, for the "Collection" resource and the "Remove Group" operation, it removes a specified group from a given collection. This is useful in scenarios where you want to revoke a group's access or association with a particular collection in your knowledge base.

Practical example: If you have a collection of documents shared with multiple groups and one group should no longer have access, this operation can be used to remove that group from the collection's permissions.

Properties

Name Meaning
Collection ID The unique identifier of the collection from which the group will be removed.
Group ID The unique identifier of the group to be removed from the collection.

(Note: The provided input properties JSON only included "Collection ID". However, the code shows that "Group ID" is also required for the "removeGroup" operation on the "collection" resource.)

Output

The output is a JSON object representing the response from the Outline API after attempting to remove the group from the collection. The exact structure depends on the API's response but typically includes confirmation of the removal or details about the updated collection.

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

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 a helper function (outlineApiRequest) to make HTTP POST requests to the Outline API endpoints.
  • No additional external services or environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Collection ID or Group ID parameters will cause the API request to fail.
    • Insufficient permissions for the API key may prevent removing groups from collections.
    • Network connectivity issues can cause request failures.

  • Error messages:

    • Errors returned by the Outline API will be passed through. For example, "Group not found" or "Collection not found" indicate invalid IDs.
    • Authentication errors suggest problems with the API key credential.

  • Resolution tips:

    • Verify that the Collection ID and Group ID are correct and exist in your Outline instance.
    • Ensure the API key has sufficient permissions to modify collections.
    • Check network connectivity and retry if transient errors occur.

Links and References

Discussion