Portainer icon

Portainer

Interact with Portainer via API

Actions190

Users → User Delete

AI-generated

Overview

This node allows you to delete a user from the system by specifying the user's unique identifier. It is useful in scenarios where you need to programmatically manage user accounts, such as removing inactive users, cleaning up test accounts, or automating user lifecycle management.

For example, you might use this node in an automation workflow that periodically deletes users who have not logged in for a certain period or when a user requests account deletion.

Properties

Name Meaning
Id User identifier (number)

The "Id" property is required and specifies the unique numeric identifier of the user to be deleted.

Output

The output JSON typically contains information about the result of the delete operation. This may include confirmation of successful deletion or error details if the operation failed.

Since this node performs a delete action, it does not output user data but rather the status or response from the API indicating whether the user was successfully deleted.

No binary data output is expected.

Dependencies

  • Requires an API key credential to authenticate with the Portainer API.
  • The node interacts with the Portainer API endpoint configured via credentials.
  • Proper permissions are needed on the API key to perform user deletion.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent user ID will likely result in an error.
    • Insufficient permissions on the API key can cause authorization errors.
    • Network connectivity issues may prevent communication with the API.

  • Error messages:

    • User not found: Verify the user ID exists.
    • Unauthorized: Check that the API key has the necessary permissions.
    • Network error: Ensure the API URL is correct and reachable.

Resolving these usually involves verifying input parameters, checking API credentials, and ensuring network access.

Links and References

Discussion