Users
To list, add, update and delete users in the organization. Also, get the details of a user.
Table Specific Information
Select
The 本製品 will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the 本製品.
- UserId supports the '=' comparison.
- Status supports the '=' comparison.
SELECT * FROM Users WHERE Status = 'All' SELECT * FROM Users ORDER BY UserRole DESC
Insert
Insert can be executed by specifying the Name,Email column. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.
INSERT INTO Users (Name,Email,UserRole) VALUES ('user1','user@cdata.com','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='user@cdata.com',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 | True |
Status of the user. 使用できる値は次のとおりです。All, Active, Inactive, Invited, Deleted |