Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation updates the roles assigned to a specific member within a team of a group. It is useful in scenarios where you need to manage user permissions dynamically, such as promoting a team member to an admin role or restricting access by changing their roles. For example, in a corporate environment, when a team member’s responsibilities change, this node can update their roles accordingly without manual intervention.

Properties

Name Meaning
Group Id Identifier of the Group to which the team belongs.
Team Id Identifier of the Team within the group.
Member Id Identifier of the member whose roles are being updated (corresponds to userId in Payhawk).
Roles JSON array specifying the roles granted to the team member. Example: ["admin", "user"]

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation of the updated member roles and possibly the updated member object or status from the API response. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the external service managing groups and teams.
  • The node uses a base URL configured in the credentials to send HTTP requests.
  • The operation depends on the external API supporting updating member roles within a team.

Troubleshooting

  • Invalid Identifiers: Errors may occur if the provided Group Id, Team Id, or Member Id do not exist or are incorrect. Verify these IDs before running the node.
  • Malformed Roles JSON: The Roles property expects valid JSON. Invalid JSON syntax will cause parsing errors. Ensure the roles input is a properly formatted JSON array.
  • Authentication Errors: If the API key or authentication token is missing or invalid, the node will fail to connect. Confirm that credentials are correctly set up.
  • Permission Denied: The authenticated user might lack permission to update roles. Check API user permissions.
  • API Rate Limits: Frequent updates might hit rate limits imposed by the external API, causing temporary failures.

Links and References

  • Refer to the external API documentation for managing groups, teams, and member roles for detailed information on required parameters and expected responses.
  • JSON formatting guides for constructing the Roles array properly.

Discussion