Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows you to add a member to a specific team within a group. It is useful in scenarios where you manage organizational structures, such as assigning users to teams for collaboration or access control purposes. For example, in a corporate environment, you might use this node to programmatically add employees to project teams based on their roles or department.

Properties

Name Meaning
Group Id Identifier of the Group where the team exists.
Team Id Identifier of the specific team to which the member will be added.
Member Id User ID representing the member to be added to the team.
Roles JSON array specifying the roles granted to the team member (e.g., ["admin", "editor"]).

Output

The node outputs JSON data representing the result of the add-member-to-team operation. This typically includes confirmation details such as the updated team membership or status of the request. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating requests to the external service managing groups and teams.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests with JSON payloads to the external API endpoint.

Troubleshooting

  • Missing or invalid Group Id/Team Id/Member Id: Ensure all required identifiers are correctly provided; otherwise, the API may return errors indicating missing parameters.
  • Invalid Roles format: The roles property expects a valid JSON array. Malformed JSON will cause parsing errors.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to modify team memberships.
  • API connectivity issues: Check network connectivity and the correctness of the base URL configuration.

Links and References

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

Discussion