Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Account Teams → Update Member Role Within A Team

AI-generated

Overview

This node operation updates the roles assigned to a specific member within an account team. It is useful for managing team permissions dynamically, such as promoting a user to a higher role or adjusting access rights without removing and re-adding them. Practical examples include changing a team member's role from "viewer" to "editor" or assigning multiple roles to reflect new responsibilities.

Properties

Name Meaning
Account Id Identifier of the account where the team exists
Team Id Identifier of the team to which the member belongs
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; can include multiple roles

Output

The node outputs JSON data representing the updated state of the team member’s roles after the operation completes. This typically includes confirmation of the new roles assigned and possibly metadata about the update. The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the external service managing accounts and teams.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on the external service’s API to perform the update operation.

Troubleshooting

  • Common issues:
    • Invalid or missing identifiers (Account Id, Team Id, Member Id) will cause the update to fail.
    • Malformed JSON in the Roles property can lead to parsing errors.
    • Insufficient permissions or invalid API credentials may result in authorization errors.
  • Error messages:
    • "Member not found" indicates the specified member ID does not exist in the given team.
    • "Invalid roles format" suggests the roles JSON is incorrectly structured.
    • "Unauthorized" or "Forbidden" errors mean the API key lacks necessary permissions.
  • Resolutions:
    • Verify all IDs are correct and correspond to existing entities.
    • Ensure the Roles input is valid JSON and matches expected role definitions.
    • Confirm that the API key has appropriate scopes/permissions for updating team members.

Links and References

  • Refer to the external service’s API documentation for details on roles and team management endpoints.
  • JSON formatting guides for constructing the Roles property correctly.

Discussion