Users
List, add, update and delete users in the organization. Also, get the details of a user.
Table Specific Information
Select
The cmdlet uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- UserId supports the '=' comparison.
- Status supports the '=' comparison.
The rest of the filter is executed client-side in the cmdlet.
For example:
SELECT * FROM Users WHERE Status = 'All' SELECT * FROM Users ORDER BY UserRole DESC
Insert
INSERT can be executed by specifying the Name and Email columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table.
INSERT INTO Users (Name, Email, UserRole) VALUES ('user1', '[email protected]', 'staff')
Update
UPDATE can be executed by specifying the UserId in the WHERE Clause. The columns that are not read-only can be updated.
For example:
UPDATE Users SET Name = 'User Name Change', Email = '[email protected]', UserRole = 'staff' WHERE UserId = '3350895000000089005'
Delete
DELETE can be executed by specifying the UserId in the WHERE Clause
For example:
DELETE FROM Users WHERE UserId = '3350895000000089001'
Columns
Name | Type | ReadOnly | References | SupportedOperators | Description |
UserId [KEY] | String | True |
Id of a user. | ||
UserRole | String | False |
Role of a user. | ||
UserType | String | True |
Type of a user. | ||
CreatedTime | Datetime | True |
Time at which the user was created. | ||
String | False |
Email Id of a user. | |||
IsAssociatedForApproval | Boolean | True |
Check if the user is associated for the approval. | ||
IsClaimant | Boolean | True |
Check if the user is claimant. | ||
IsCustomerSegmented | Boolean | True |
Check if the user is customer segmented. | ||
IsEmployee | Boolean | True |
Check if the user is an employee. | ||
Name | String | False |
Name of the user. | ||
PhotoUrl | String | True |
Photo URL of the user. | ||
RoleId | String | False |
Role Id of a user. | ||
CostRate | Double | False |
Hourly cost rate. | ||
Status | String | False |
Status of the user. The allowed values are All, Active, Inactive, Invited, Deleted. |