PortainerInstall

Overview

This node interacts with the Portainer API to list users. It is useful for scenarios where you need to retrieve a list of authorized users within a Portainer environment, such as managing user access, auditing user accounts, or integrating user data into workflows. For example, an administrator could use this node to fetch all users filtered by a specific environment ID to monitor who has access to that environment.

Properties

Output

The node outputs JSON data representing the list of users retrieved from the Portainer API. Each item in the output corresponds to a user object containing details such as user ID, username, roles, and other metadata as provided by the API. The output does not include binary data.

Dependencies

• Requires an API key credential for authenticating with the Portainer API.
• The base URL for the Portainer API must be configured in the node credentials.
• The node depends on the @devlikeapro/n8n-openapi-node package and a bundled OpenAPI specification (openapi.json) for request building.

Troubleshooting

• Authentication errors: Ensure the API key credential is valid and has sufficient permissions to list users.
• Invalid environment ID: If filtering by environment ID, verify that the ID exists and is correct; otherwise, the API may return an empty list or an error.
• Network issues: Confirm that the Portainer API endpoint URL is reachable from the n8n instance.
• Unexpected API responses: Check if the Portainer API version matches the expected version used by the node, as breaking changes might affect the output.

Links and References

• Portainer API Documentation
• n8n Documentation on Creating Nodes