Portainer icon

Portainer

Interact with Portainer via API

Actions190

Users → User Inspect

AI-generated

Overview

This node interacts with the Portainer API to inspect a specific user by their unique identifier. It is useful in scenarios where you need to retrieve detailed information about a user managed within Portainer, such as for auditing, monitoring, or managing user accounts programmatically.

For example, you might use this node to:

  • Fetch user details before performing administrative actions.
  • Verify user existence and status in automated workflows.
  • Integrate user data retrieval into larger automation pipelines involving Portainer.

Properties

Name Meaning
Id The unique numeric identifier of the user to inspect. This is a required property and specifies which user's details will be retrieved from Portainer.

Output

The node outputs JSON data containing detailed information about the specified user. This typically includes user attributes such as username, role, status, and other metadata provided by the Portainer API. The exact structure depends on the API response but generally represents a single user object.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the Portainer API must be set in the node's credential configuration.

Troubleshooting

  • Invalid User ID: If the provided user ID does not exist, the node may return an error indicating that the user was not found. Verify the ID is correct.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is valid and has sufficient permissions.
  • Network Issues: Connectivity problems to the Portainer server can result in timeouts or unreachable errors. Check network access and URL correctness.
  • API Changes: If the Portainer API changes, the node might fail to parse responses correctly. Keep the node and API version compatible.

Links and References

Discussion