Portainer icon

Portainer

Interact with Portainer via API

Actions190

Users → User Memberships Inspect

AI-generated

Overview

This node interacts with the Portainer API to inspect user memberships. Specifically, for the "Users" resource and the "User Memberships Inspect" operation, it retrieves membership details of a specified user by their identifier. This is useful in scenarios where you need to audit or manage user access within Portainer, such as verifying which teams or environments a user belongs to.

Example use cases:

  • Checking the groups or roles assigned to a user before modifying permissions.
  • Automating reports on user memberships for compliance or security reviews.
  • Integrating user membership data into broader workflows for access management.

Properties

Name Meaning
Id User identifier (number). The unique ID of the user whose memberships you want to inspect.

Output

The node outputs JSON data representing the membership information of the specified user. This typically includes details about the teams, roles, or environments the user is associated with in Portainer. The exact structure depends on the Portainer API response but generally contains arrays or objects describing these memberships.

If the node supports binary data output, it would relate to any files or attachments returned by the API, but based on the provided code and operation, this node primarily outputs JSON membership data.

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 credentials configuration.

Troubleshooting

  • Common issues:

    • Invalid or missing user ID: Ensure the "Id" property is correctly set to a valid user identifier.
    • Authentication errors: Verify that the API key or token is correct and has sufficient permissions.
    • Network or connectivity problems: Confirm that the Portainer API endpoint is reachable from n8n.

  • Error messages:

    • Unauthorized or 401 errors indicate invalid credentials; reconfigure the API authentication.
    • 404 Not Found may mean the user ID does not exist; double-check the user identifier.
    • Timeout or network errors suggest connectivity issues; check network settings and API availability.

Links and References

Discussion