Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation updates the roles of a specific member within a team that belongs to 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 changes responsibilities, this node can update their access rights accordingly.

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 within the specified team and group. The exact structure depends on the API response but generally contains details about the member and their new roles.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the external service managing groups, teams, and members.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP requests to interact with the external API endpoint responsible for updating team member roles.

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. Ensure the input is correctly formatted; otherwise, parsing errors will occur.
  • Authentication Failures: If the API key or authentication token is missing or invalid, the node will fail to connect. Confirm that credentials are properly 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 service, causing temporary failures.

Links and References

  • Refer to the external API documentation for managing groups, teams, and members to understand role definitions and constraints.
  • JSON formatting guides to ensure correct input for the Roles property.

Discussion