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, among other resources. Specifically, the "Remove User" operation under the "Collection" resource allows you to remove a user from a specified collection. This is useful in scenarios where you want to revoke a user's access or membership to a particular collection within your knowledge base.

Practical examples include:

  • Automating user access management by removing users who no longer require access to certain collections.
  • Integrating with HR systems to automatically update collection memberships when employees leave teams.
  • Managing permissions dynamically based on workflow conditions.

Properties

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

Output

The output is a JSON object representing the response from the Outline API after attempting to remove the user from the collection. It typically contains confirmation of the removal or details about the updated collection state.

Example structure (simplified):

{
  "success": true,
  "collectionId": "string",
  "userId": "string"
}

If the operation fails, the output may contain an error message describing the issue.

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 external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Common Issues:

    • Invalid or missing Collection ID or User ID parameters will cause the API request to fail.
    • Insufficient permissions of the API key to modify collection memberships can result in authorization errors.
    • Network issues or incorrect API endpoint configuration may lead to connection failures.

  • Error Messages:

    • "error": "User not found in collection": The specified user is not a member of the collection.
    • "error": "Collection not found": The provided collection ID does not exist.
    • "error": "Unauthorized": The API key lacks permission to modify the collection.

  • Resolutions:

    • Verify that the Collection ID and User ID are correct and correspond to existing entities.
    • Ensure the API key has sufficient privileges to manage collection memberships.
    • Check network connectivity and API endpoint settings.

Links and References

Discussion