Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

The 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 with the Get Memberships operation, it retrieves user membership information for a specified collection. This is useful when you want to see which users have access to a particular collection and their associated permissions.

Practical examples include:

  • Auditing who has access to a knowledge base collection.
  • Automating reports on user memberships in collections.
  • Integrating membership data into other workflows or systems for access control management.

Properties

Name Meaning
Collection ID The unique identifier of the collection whose user memberships you want to retrieve.

Output

The output is a JSON object (or an array of objects if multiple items are processed) containing the user memberships of the specified collection. Each membership entry typically includes details about the user and their permission level within that collection.

The exact structure depends on the Outline API response for the /collections.memberships endpoint but generally includes fields like user IDs, roles/permissions, and possibly metadata about the membership.

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 via HTTP POST requests.
  • No additional external dependencies beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Collection ID will cause the API request to fail.
    • Insufficient permissions on the API key may result in authorization errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Errors returned from the Outline API will be passed through, often indicating issues like "collection 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.

  • Resolutions:

    • Verify the Collection ID is correct and exists in your Outline instance.
    • Ensure the API key used has sufficient permissions to read collection memberships.
    • Check network settings and retry if transient errors occur.

Links and References

Discussion