AvantGuard - ClerkChat icon

AvantGuard - ClerkChat

AvantGuard - ClerkChat

Overview

This node operation, "Remove Users From Team" under the "Reseller" resource, is designed to remove one or more users from a specified team. It is useful in scenarios where team membership needs to be managed dynamically, such as when users leave an organization, change roles, or need to be reassigned. For example, an administrator can automate the removal of multiple users from a project team after project completion or when access rights are revoked.

Properties

Name Meaning
Team Id The unique identifier of the team from which users will be removed. This is a required string input.
User Ids A JSON array containing the IDs of the users to be removed from the team. This is a required field and expects valid JSON input representing user identifiers.

Output

The node outputs data in the json field that typically reflects the result of the removal operation. This may include confirmation of successful removals or details about any errors encountered during the process. The exact structure depends on the API response but generally includes status information related to the users removed from the team.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the external service managing teams and users.
  • The node uses a base URL configured via credentials to connect to the relevant API endpoint.
  • The operation sends HTTP requests with JSON payloads to perform the removal action.

Troubleshooting

  • Invalid Team Id or User Ids: If the provided team ID or user IDs are incorrect or do not exist, the API may return errors indicating not found or invalid parameters. Verify the IDs before running the node.
  • Malformed JSON in User Ids: Since the user IDs are expected as a JSON array, ensure the input is correctly formatted JSON. Parsing errors will prevent the request from being sent.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key or token is correctly configured in the node credentials.
  • API Rate Limits or Permissions: If the API enforces rate limits or requires specific permissions, operations might fail. Check API documentation and user permissions if errors occur.

Links and References

  • Refer to the external API documentation for team and user management for detailed information on request formats and error codes.
  • JSON formatting guides can help ensure correct input for the User Ids property.

Discussion