Outline icon

Outline

Interact with Outline knowledge base

Overview

This node interacts with the Outline knowledge base API to manage collections and their related data. Specifically, the "Get Group Memberships" operation under the "Collection" resource retrieves the group memberships associated with a specified collection. This is useful for scenarios where you want to understand or audit which groups have access or membership within a particular collection in your knowledge base.

Practical examples include:

  • Automating access reviews by listing all groups linked to a collection.
  • Integrating with other systems to synchronize group permissions.
  • Generating reports on collection access control.

Properties

Name Meaning
Collection ID The unique identifier of the collection for which to retrieve group memberships.

Output

The output JSON contains the response from the Outline API endpoint that lists group memberships for the specified collection. It typically includes an array of group membership objects, each describing a group's association with the collection (e.g., group ID, name, permission level).

The output structure is:

{
  "memberships": [
    {
      "groupId": "string",
      "groupName": "string",
      "permission": "read" | "read_write",
      ...
    },
    ...
  ],
  ...
}

(Note: Exact fields depend on the Outline API's response schema.)

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node uses HTTP POST requests to communicate with Outline's endpoints.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Collection ID: Ensure the Collection ID provided is correct and exists in Outline.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or connectivity problems: Check network access to the Outline API endpoint.
  • Error messages:

    • "error": "Unauthorized": Indicates invalid or missing API credentials; reconfigure the API key.
    • "error": "Collection not found": The specified Collection ID does not exist; verify the ID.
    • Timeout or connection errors: May require checking firewall or proxy settings.

Links and References

Discussion