Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation updates the roles assigned to a specific member within an account team. It is useful in scenarios where you need to modify the permissions or responsibilities of a user in a team context, such as promoting a member to an admin role or restricting access by changing their roles.

Practical examples include:

  • Changing a team member’s role from "viewer" to "editor" to grant them more privileges.
  • Removing certain roles from a member when their responsibilities change.
  • Assigning multiple roles at once to reflect complex permission sets.

Properties

Name Meaning
Account Id Identifier of the account to which the team belongs.
Team Id Identifier of the team where the member's role will be updated.
Member Id Identifier of the member whose roles are being updated (corresponds to userId in Payhawk).
Roles JSON array representing the roles granted to the team member. Example: ["admin", "editor"]

Output

The node outputs JSON data reflecting the result of the update operation. This typically includes confirmation of the updated member roles and possibly the updated team member object. The exact structure depends on the API response but generally contains fields like member identifiers 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 accounts and teams.
  • The node expects a base URL configuration for the API endpoint.
  • The operation relies on sending a properly formatted JSON body containing the roles array.

Troubleshooting

  • Invalid or missing identifiers: Ensure that Account Id, Team Id, and Member Id are correctly provided and correspond to existing entities.
  • Malformed roles JSON: The roles property must be valid JSON. Invalid JSON will cause parsing errors.
  • Permission errors: The API key used must have sufficient permissions to update team member roles; otherwise, authorization errors may occur.
  • API connectivity issues: Network problems or incorrect base URL configurations can lead to request failures.

Common error messages might include:

  • "Member not found" — Verify the Member Id.
  • "Unauthorized" or "Forbidden" — Check API credentials and permissions.
  • "Invalid roles format" — Confirm the roles JSON syntax.

Links and References

  • Refer to the external API documentation for detailed information on roles and team management.
  • JSON formatting guides for constructing the roles array properly.

Discussion