Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Accounts → Update Account User

AI-generated

Overview

This node operation updates a user's role and optionally their external identifier within a specified account. It is useful in scenarios where user permissions or roles need to be changed dynamically, such as promoting an employee to an admin role or adjusting access levels based on organizational changes. For example, if a company wants to change a user's role from "Employee" to "Accounting" to grant them access to financial data, this node operation facilitates that update seamlessly.

Properties

Name Meaning
Account Id Identifier of the account where the user belongs.
User Id Identifier of the user whose details are being updated.
Role New role assigned to the user. Options: Admin, Accounting, Employee.
External Id Unique identifier of the account user in an external system (optional).

Output

The node outputs JSON data representing the updated user information within the account. This typically includes confirmation of the updated fields such as the new role and any external ID set. The output structure reflects the API response confirming the successful update of the user details.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Common Issues:
    • Invalid or missing Account Id or User Id will cause the update to fail.
    • Insufficient permissions associated with the API key may prevent role updates.
    • Providing an invalid role value outside the allowed options will result in an error.
  • Error Messages:
    • "User not found" indicates the provided User Id does not exist in the specified account.
    • "Account not found" means the Account Id is incorrect or inaccessible.
    • "Unauthorized" suggests issues with API authentication; verify the API key and permissions.
  • Resolutions:
    • Double-check the Account Id and User Id values for correctness.
    • Ensure the API key has sufficient privileges to update user roles.
    • Use one of the predefined role options: Admin, Accounting, or Employee.

Links and References

  • Refer to the external service’s API documentation for detailed information on user management endpoints.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for custom integrations.

Discussion