Portainer icon

Portainer

Interact with Portainer via API

Actions190

Team Memberships → Team Membership Update

AI-generated

Overview

This node updates a team membership in the Portainer system via its API. It is useful when you need to modify details of an existing team membership, such as changing roles or permissions associated with a user within a team. For example, if a user's access level needs to be elevated or restricted within a team, this node can perform that update programmatically.

Properties

Name Meaning
Id The unique identifier of the team membership to update. This is a required numeric value specifying which team membership record will be modified.
Body The details of the team membership to update, provided as a JSON string. This contains the new data for the team membership, such as updated roles or other relevant fields.

Output

The node outputs the response from the Portainer API after attempting to update the team membership. The output is structured as JSON and typically includes the updated team membership details or confirmation of the update operation. There is no indication that binary data is returned by this node.

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 uses HTTP requests with JSON payloads to communicate with the Portainer API.

Troubleshooting

  • Invalid Id: If the provided team membership Id does not exist, the API may return an error indicating the resource was not found. Verify the Id before running the node.
  • Malformed Body: The Body property must be a valid JSON string representing the team membership details. Invalid JSON will cause request failures.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions to update team memberships.
  • API Endpoint Issues: Confirm the base URL is correct and the Portainer server is reachable.

Links and References

Discussion