Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base API to manage groups and their users. Specifically, the "Remove User" operation under the "Group" resource allows you to remove a user from a specified group. This is useful in scenarios where you need to automate membership management within your organization's knowledge base, such as revoking access for users who no longer require it or managing team memberships dynamically.

Practical example: If a team member leaves a project, you can use this node to automatically remove their user access from the relevant group in Outline, ensuring that sensitive information remains secure.

Properties

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

Output

The output is a JSON object representing the response from the Outline API after attempting to remove the user from the group. It typically contains confirmation details about the removal operation or error information if the operation failed.

No binary data is output by this operation.

Example output structure (simplified):

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

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Group ID or User ID parameters will cause the API request to fail.
    • Insufficient permissions on the API key may prevent user removal.
    • Network connectivity issues can cause request failures.

  • Error messages:

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

Links and References

Discussion