Deactivate User
Table of Contents
Overview
The zoho.one.deactivateUser task is used to deactivate a user using their ID in the specified organization.
Note: Deactivating a user will unassign/disable the user from all associated applications.
Syntax
<response> = zoho.one.deactivateUser(<orgID>, <userID>, <connection>);
Scope
ZohoOne.Users.DELETE
where,
Parameter | Description | Data type |
response | is the variable that will hold the details of the user deactivated from the organization. | KEY-VALUE |
<orgID> | is the ID of the organization from which the user needs to be deactivated. | NUMBER |
<userID> | is the ID of the user who needs to be deactivated. | NUMBER |
<connection> | is the name of the Zoho One connection. | TEXT |
Example
The following script deactivates a user with ID - 1510XXXXXXXX from an organization with ID - 72XXXXXXX in Zoho One:
response = zoho.one.deactivateUser(72XXXXXXX, 1510XXXXXXXX, "zoho_one_connection");
where:
response
This is the KEY-VALUEresponse returned by Zoho One.
72XXXXXXX
This is the NUMBERthat represents the organization ID of Zoho One account.
1510XXXXXXXX
This is the NUMBERthat represents the user ID of a user who needs to be deactivated.
zoho_one_connection
This is the TEXTthat represents the link name of the connection.
Response Format
{
"status_code": 204,
"resource_name": "activate",
"message": "User has been deactivated successfully!"
}