Users
Gets the details of all the users in a specific portal.
Select
- Id supports '=' operator
- FirstName supports '=,!=,CONTAINS' operators
- LastName supports '=,!=,CONTAINS' operators
- Email supports '=,!=,CONTAINS' operators
- BusinessHoursId supports '=,!=,CONTAINS' operators
- PortalProfileId supports '=' operator
- RoleId supports '=' operator
- UserType supports '=' operator
- ViewType supports '=' operator
- Columns that support server-side ORDER BY: Id, FirstName, LastName, PortalProfileName, RoleName, AddedTime, UpdatedTime, LastAccessedOn
SELECT * FROM Users WHERE Id = '460276000000139095'
Insert
To add a new Portal User you can specify the following fields:
- PortalProfileId
- ReportingToId
- RoleId
- BudgetCostRatePerHourAmount
- EmailTemplate
INSERT INTO Users(Email, RoleId) VALUES ('[email protected]', '274567865458')
Update
To update a User specify the Id field.
UPDATE Users SET ProjectCostRateAmount = 2 WHERE Id = '123456000000045018'
Delete
Users can be deleted by providing the Id and Notify fields and issuing a DELETE statement.
DELETE FROM Users WHERE Id = '123456000000045018' AND Notify = true
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Long | True |
User Id. |
| FirstName | String | True |
User First Name. |
| LastName | String | True |
User Last Name. |
| FullName | String | True |
User Full Name. |
| IsConfirmed | Boolean | True |
User Is Confirmed. |
| IsResendInvite | Boolean | True |
User Is Resend Invite. |
| String | False |
User Email. | |
| BusinessHoursId | Long | False |
User Business Hours Id. |
| BusinessHoursName | String | True |
User Business Hours Name. |
| PortalProfileId | Long | False |
User Portal Profile Id. |
| PortalProfileName | String | True |
User Portal Profile Name. |
| PortalProfileIsDefault | Boolean | True |
User Portal Profile Is Default. |
| ReportingToId | Long | False |
Reporting To Id. |
| ReportingToFirstName | String | True |
Reporting To First Name. |
| ReportingToLastName | String | True |
Reporting To Last Name. |
| ReportingToZuid | Long | True |
Reporting To Zuid. |
| RoleId | Long | False |
User Role Id. |
| RoleName | String | True |
User Role Name. |
| Zuid | Long | True |
User Zuid. |
| UserType | String | True |
User Type. The allowed values are portal_user, client_user, client_contact. |
| Status | String | True |
User Status. |
| AddedTime | Datetime | True |
User Added Time. |
| UpdatedTime | Datetime | True |
User Updated Time. |
| LastAccessedOn | Datetime | True |
User Last Accessed On Time. |
| BudgetCostRatePerHourFormattedAmount | String | True |
Formatted amount of the cost rate per hour. |
| BudgetCostRatePerHourAmount | Decimal | False |
Cost rate per hour amount. |
| ViewType | String | True |
View type. The allowed values are active, inactive, active_read_only, inactive_read_only, subordinates_active, direct_reports_active, activate_user_request, sandboxdevelopers. |
| Notify | Boolean | False |
Specify whether to notify the user about the removal. Required to use when deleting a user. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| EmailTemplate | Long |
ID of the invitation email template to use when sending the invitation during insert. |