Nginx Proxy Manager (NPM) icon

Nginx Proxy Manager (NPM)

Interact with your NPM instance
Join our community

Actions38

Overview

This node integrates with an Nginx Proxy Manager (NPM) instance to manage various resources including users, proxy hosts, access lists, certificates, and more. Specifically, the User - Update Permissions operation allows updating a user's permissions related to different resource types managed by NPM.

Typical use cases include automating user permission management in environments where multiple users need controlled access to proxy hosts, redirection hosts, dead hosts, streams, access lists, and SSL certificates. For example, an administrator can programmatically adjust whether a user can manage or only view certain proxy hosts, or restrict visibility of items they did not create.

Properties

Name Meaning
ID The unique numeric identifier of the user whose permissions are being updated.
Options A collection of permission settings for the user across different resource categories:
  Visibility Controls whether the user sees only items they created ("Created Item Only") or all items ("All Item").
  Proxy Hosts Permission level for proxy hosts: "Manage", "View Only", or "Hidden".
  Redirection Hosts Permission level for redirection hosts: "Manage", "View Only", or "Hidden".
  Dead Hosts Permission level for dead hosts: "Manage", "View Only", or "Hidden".
  Streams Permission level for streams: "Manage", "View Only", or "Hidden".
  Access Lists Permission level for access lists: "Manage", "View Only", or "Hidden".
  SSL Certificates Permission level for SSL certificates: "Manage", "View Only", or "Hidden".

Output

The node outputs JSON data representing the result of the update operation. Typically, this will include confirmation of success or details about the updated user permissions. The exact structure depends on the API response from the NPM instance but generally includes fields indicating the status of the update.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to an Nginx Proxy Manager instance.
  • Needs credentials containing:
    • The base URL of the NPM API.
    • An email and password for authentication to obtain an API token.
  • The node internally authenticates by requesting a token from the /api/tokens endpoint before performing operations.
  • No additional external dependencies beyond the NPM API and valid credentials.

Troubleshooting

  • Login failed: No token received
    This error indicates that authentication to the NPM API failed, likely due to incorrect credentials (email or password) or connectivity issues. Verify the credentials and ensure the NPM instance is reachable.

  • Invalid User ID
    If the provided user ID does not exist, the API may return an error. Confirm the user ID is correct and corresponds to an existing user.

  • Permission Update Failures
    Errors during permission updates might occur if invalid permission values are supplied or if the authenticated user lacks rights to modify other users. Check the options provided and ensure the API user has sufficient privileges.

  • Network or API Endpoint Issues
    Ensure the base URL is correct and the NPM API is accessible from the n8n environment.

Links and References

Discussion