Users
Create, update, delete, and query the SuiteCRM registered users.
Table Specific Information
Select
You can query the Users table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.
SELECT * FROM Users WHERE Username LIKE '%test%' AND [Date Created] > '2017-10-09'
Insert
Create a User by specifying any writable column.
INSERT INTO Users ([First Name], [Last Name], Title) VALUES ('First', 'Last', 'Mr')
Update
The Users table does not allow updates to its columns. Update the entries from the Employees table instead.
UPDATE Employees SET [Title] = 'Dr.', Department = 'HR' WHERE Id = 'test123'
Delete
Remove a User by specifying the Id.
DELETE FROM Users WHERE Id = 10003
Columns
| Name | Type | ReadOnly | Description |
| ID [KEY] | String | False |
The unique identifier of the user. |
| AcceptStatusC | String | False |
The fields for the accept status of the call. |
| AcceptStatusId | String | False |
The Id of the accept status. |
| AcceptStatusM | String | False |
The fields for the accept status of the meeting. |
| AcceptStatusName | String | False |
The name of the accept status. |
| AddressCity | String | False |
The city in the address. |
| AddressCountry | String | False |
The country in the address. |
| AddressPostalCode | String | False |
The ZIP code in the address. |
| AddressState | String | False |
The state in the address. |
| AddressStreet | String | False |
The street address of the user. |
| AssignedTo | String | False |
The Id of the user who created the record. |
| AuthenticationId | String | False |
The authentication Id. |
| CreatedByName | String | True |
The name of the user who created the record. |
| DateEntered | Datetime | True |
The date the record was created. |
| DateModified | Datetime | True |
The date the record was last modified. |
| Deleted | Bool | False |
The record deletion indicator. |
| Department | String | False |
The department of the user. |
| Description | String | False |
The description for the user. |
| DisplayEmployeeRecord | Bool | False |
Whether the user is shown on the employees tab. |
| EmailAddress | String | False |
The alternate email address of the user. |
| EmailClient | String | False |
The link type of the email. |
| EmployeeStatus | String | False |
The status of the employee. |
| ExternalAuthentication | Bool | False |
Whether only external authentication is enabled for the user. |
| Fax | String | False |
The fax of the user. |
| FirstName | String | False |
The first name of the user. |
| FullName | String | False |
The full name of the user. |
| GroupUser | Bool | False |
Whether the user is a group. |
| HomePhone | String | False |
The home phone number of the user. |
| IMName | String | False |
The Id of the messenger. |
| IMType | String | False |
The type of the messenger. |
| IsAdministrator | Bool | False |
Whether the user is an admin. |
| IsSuiteCRMUser | Bool | False |
Whether the user is SuiteCRM user. If not, it is a guest user. |
| LastName | String | False |
The last name of the user. |
| LBL_SECURITYGROUP_NONINHERITABLE | Bool | False |
Whether the group is non inheritable. |
| LBL_securitygroup_noninherit_id | String | False |
The security group's non-inheritance id. |
| Mobile | String | False |
The mobile phone number of the user. |
| ModifiedById | String | True |
The Id of the user who last modified the record. |
| ModifiedByName | String | True |
The name of the user who last modified the record. |
| Name | String | False |
Full name for the user |
| NotifyonAssignment | Bool | False |
Whether the user can receive notifications. |
| OtherPhone | String | False |
The alternate phone number of the user. |
| Password | String | False |
The hashed password for the user. |
| PasswordLastChanged | Datetime | False |
The date and time the password was last changed. |
| Photo | String | False |
The photo for the user. |
| PortalAPIUser | Bool | False |
Whether the user is portal only. |
| PrimaryGroup | Bool | False |
The primary security group the user is assigned to. |
| Reportsto | String | False |
The name of the manager of the user. |
| ReportstoID | String | False |
The Id of the manager of the user. |
| SecurityGroup | String | False |
The security group's fields that are selected for non-inheritance. |
| Status | String | False |
The status of the user. |
| SystemGeneratedPassword | Bool | False |
Whether the user has a system-generated password. |
| Title | String | False |
The title of the user. |
| UserType | String | False |
The type of the user. |
| Username | String | False |
The user name of the user. |
| WorkPhone | String | False |
The work phone number of the user. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Rows@Next | String |
Identifier for the next page of results. Do not set this value manually. |