Workspace icon

Workspace

Get and change data from Workspace API

Overview

The node interacts with a Workspace API to manage various resources, including users. Specifically, for the "User" resource and the "Delete User" operation, it deletes a user identified by a unique user ID from the workspace system. This is useful in scenarios where user accounts need to be removed due to role changes, offboarding, or cleanup of inactive users.

Practical examples:

  • Automatically removing a user from the workspace when they leave an organization.
  • Cleaning up test or temporary user accounts after project completion.
  • Integrating with HR systems to sync user deletions.

Properties

Name Meaning
User ID Unique identifier of the user to delete

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or details about the deleted user. The exact structure depends on the Workspace API's response but generally confirms success or failure.

No binary data output is indicated.

Dependencies

  • Requires connection to the Workspace API.
  • Needs an API key credential and tenant information configured in n8n credentials.
  • The base URL for the Workspace API must be set in the node credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing User ID: The node requires a valid user identifier; otherwise, the API call will fail.
    • Authentication errors: Ensure that the API key and tenant credentials are correctly configured.
    • Network or API endpoint issues: Verify the base URL and network connectivity.
  • Error messages:

    • Unauthorized or authentication failed: Check API key and tenant credentials.
    • User not found: Confirm the User ID exists in the workspace.
    • Bad request or validation errors: Ensure the User ID format matches expected patterns.

Links and References

  • Refer to the Workspace API documentation for detailed information on user management endpoints.
  • n8n documentation on setting up API credentials and HTTP request nodes.

Discussion