Remove User from a Group
Table of Contents
Note:
- This task is applicable to all services except Zoho Creator.
- Each time the zoho.one.removeUserFromGroup integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
- Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.one.removeUserFromGroup integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.
Overview
The zoho.one.removeUserFromGroup task is used to remove a user from the specified group in an organization.
Syntax
<response> = zoho.one.removeUserFromGroup(<orgID>, <groupID>, <userID>, <connection>);
Scope
ZohoOne.Groups.DELETE
where:
| Parameter | Description | Data type |
| response | is the variable which will hold the details of the user removed from the specified group in the organization. | KEY-VALUE |
| <orgID> | is the ID of the organization from which the user needs to be removed. | NUMBER |
| <groupID> | is the ID of the group from which the user needs to be removed. | NUMBER |
| <userID> | is the ID of the user who needs to be removed. | NUMBER |
| <connection> | is the name of the Zoho One connection. | TEXT |
Example
The following script removes a user with ID - 1510XXXXXXXX from a specified group with ID - 68XXXXXXX from an organization with ID - 72XXXXXXX in Zoho One:
response = zoho.one.removeUserFromGroup(72XXXXXXX, 68XXXXXXX, 1510XXXXXXXX, "zoho_one_connection");
where:
responseThis is the KEY-VALUEresponse returned by Zoho One.
72XXXXXXXThis is the NUMBERthat represents the organization ID of Zoho One account.
1510XXXXXXXXThis is the NUMBERthat represents the user ID of a user who needs to be deactivated.
zoho_one_connectionThis is the TEXTthat represents the link name of the connection.
Response format
{
"status_code": 204,
"resource_name": "members",
"message":"Group has been unassigned successfully."
}
"status_code": 204,
"resource_name": "members",
"message":"Group has been unassigned successfully."
}