Represents a new user to be created in the system.
| Name | Editable? | Required? | Type | Nullable? | Summary |
|---|---|---|---|---|---|
| Password | This field is editable through the web API. | String | This field is nullable. | The password of the new user. | |
| DesktopID | This field is editable through the web API. | Guid | The UID of the desktop to assign to the new user. | ||
| LinkDesktop | This field is editable through the web API. | Boolean | Whether or not to link the desktop to the template. | ||
| IsActive | This field is editable through the web API. | Boolean | The active status of the new user. | ||
| IsConfidential | This field is editable through the web API. | Boolean | The confidential status of the new user. | ||
| UserName | This field is editable through the web API. | String | This field is nullable. | The username of the new user, for use when using TeamDynamix authentication. | |
| FirstName | This field is editable through the web API. | This field is required. | String | The first name of the new user. | |
| LastName | This field is editable through the web API. | This field is required. | String | The last name of the new user. | |
| MiddleName | This field is editable through the web API. | String | This field is nullable. | The middle name of the new user. | |
| Salutation | This field is editable through the web API. | String | This field is nullable. | The salutation of the new user. | |
| Nickname | This field is editable through the web API. | String | This field is nullable. | The nickname of the new user. | |
| DefaultAccountID | This field is editable through the web API. | Int32 | The ID of the default account/department associated with the new user. | ||
| DefaultAccountName | String | The name of the default account/department associated with the new user. | |||
| PrimaryEmail | This field is editable through the web API. | This field is required. | String | The primary email address of the new user. | |
| AlternateEmail | This field is editable through the web API. | String | This field is nullable. | The alternate email address of the new user. | |
| ExternalID | This field is editable through the web API. | String | This field is nullable. | The organizational ID of the new user. | |
| AlternateID | This field is editable through the web API. | String | This field is nullable. | The alternate ID of the new user. | |
| Applications | This field is editable through the web API. | String[] | This field is nullable. | The system-defined (non-platform) applications which should be granted to the new user. | |
| SecurityRoleID | This field is editable through the web API. | String | This field is nullable. | The UID of the global security role associated with the new user. | |
| SecurityRoleName | String | The name of the global security role associated with the new user. | |||
| Permissions | This field is editable through the web API. | String[] | This field is nullable. | The global security role permissions for the new user. | |
| OrgApplications | TeamDynamix.Api.Apps.UserApplication[] | This field is nullable. | The organizationally-defined (platform) applications for this user. | ||
| PrimaryClientPortalApplicationID | This field is editable through the web API. | Int32 | This field is nullable. | The ID of the primary client portal application for the new user. | |
| GroupIDs | This field is editable through the web API. | Int32[] | This field is nullable. | The IDs of groups associated with the new user. | |
| ReferenceID | Int32 | The integer ID of the new user. | |||
| AlertEmail | This field is editable through the web API. | String | This field is nullable. | The alert email address of the new user for receiving system notifications. | |
| Company | This field is editable through the web API. | This field is required. | String | The company of the new user. | |
| Title | This field is editable through the web API. | String | This field is nullable. | The title of the new user. | |
| HomePhone | This field is editable through the web API. | String | This field is nullable. | The home phone number of the new user. | |
| PrimaryPhone | This field is editable through the web API. | String | This field is nullable. | The primary phone number of the new user. | |
| WorkPhone | This field is editable through the web API. | String | This field is nullable. | The work phone number of the new user. | |
| Pager | This field is editable through the web API. | String | This field is nullable. | The pager number of the new user. | |
| OtherPhone | This field is editable through the web API. | String | This field is nullable. | The other phone number of the new user. | |
| MobilePhone | This field is editable through the web API. | String | This field is nullable. | The mobile phone number of the new user. | |
| Fax | This field is editable through the web API. | String | This field is nullable. | The fax number of the new user. | |
| DefaultPriorityID | This field is editable through the web API. | Int32 | The ID of the default priority associated with the new user. | ||
| DefaultPriorityName | String | The name of the default priority associated with the new user. | |||
| AboutMe | This field is editable through the web API. | String | This field is nullable. | The "About Me" information associated with the new user. | |
| TechnicianSignature | This field is editable through the web API. | String | This field is nullable. | The technician signature associated with the new user. | |
| ApplyTechnicianSignatureToUpdatesAndComments | This field is editable through the web API. | Boolean | Determines whether the technician signature associated with the new user is applied to the updates and comments for all tickets and ticket tasks. | ||
| ApplyTechnicianSignatureToReplies | This field is editable through the web API. | Boolean | Determines whether the technician signature associated with the new user is applied to the replies for all tickets and ticket tasks. | ||
| WorkAddress | This field is editable through the web API. | String | This field is nullable. | The work address of the new user. | |
| WorkCity | This field is editable through the web API. | String | This field is nullable. | The work city of the new user. | |
| WorkState | This field is editable through the web API. | String | This field is nullable. | The work state/province abbreviation of the new user. | |
| WorkZip | This field is editable through the web API. | String | This field is nullable. | The work zip code of the new user. | |
| WorkCountry | This field is editable through the web API. | String | This field is nullable. | The work country of the new user. | |
| HomeAddress | This field is editable through the web API. | String | This field is nullable. | The home address of the new user. | |
| HomeCity | This field is editable through the web API. | String | This field is nullable. | The home city of the new user. | |
| HomeState | This field is editable through the web API. | String | This field is nullable. | The home state abbreviation of the new user. | |
| HomeZip | This field is editable through the web API. | String | This field is nullable. | The home zip code of the new user. | |
| HomeCountry | This field is editable through the web API. | String | This field is nullable. | The home country of the new user. | |
| DefaultRate | This field is editable through the web API. | Double | The default bill rate of the new user. | ||
| CostRate | This field is editable through the web API. | Double | The cost rate of the new user. | ||
| IsEmployee | This field is editable through the web API. | Boolean | The employee status of the new user. | ||
| WorkableHours | This field is editable through the web API. | Double | The number of workable hours in a work day for the new user. | ||
| IsCapacityManaged | This field is editable through the web API. | Boolean | Whether the new user's capacity is managed, meaning they can have capacity and will appear on capacity/availability reports. | ||
| ReportTimeAfterDate | This field is editable through the web API. | DateTime | The date after which the new user should start reporting time. This also governs capacity calculations. | ||
| EndDate | This field is editable through the web API. | DateTime | The date after which the new user is no longer available for scheduling and no longer required to log time. | ||
| ShouldReportTime | This field is editable through the web API. | Boolean | Whether the new user should report time. | ||
| ReportsToUID | This field is editable through the web API. | String | This field is nullable. | The UID of the user who the new user reports to. | |
| ReportsToFullName | String | The full name of the user who the new user reports to. | |||
| ResourcePoolID | This field is editable through the web API. | Int32 | The ID of the resource pool associated with the new user. | ||
| ResourcePoolName | String | The name of the resource pool associated with the new user. | |||
| TZID | This field is editable through the web API. | Int32 | The ID of the time zone associated with the new user. | ||
| TZName | String | The name of the time zone associated with the new user. | |||
| TypeID | This field is editable through the web API. | This field is required. | TeamDynamix.Api.Users.UserType | The type of the new user. | |
| AuthenticationUserName | This field is editable through the web API. | String | This field is nullable. | The authentication username of the new user, used for authenticating with non-TeamDynamix authentication types. | |
| AuthenticationProviderID | This field is editable through the web API. | Int32 | This field is nullable. | The ID of the authentication provider the new user will use for authentication. | |
| Attributes | This field is editable through the web API. | TeamDynamix.Api.CustomAttributes.CustomAttribute[] | This field is nullable. | The custom attributes associated with the new user. | |
| IMProvider | This field is editable through the web API. | String | This field is nullable. | The Instant Messenger (IM) provider associated with the new user. | |
| IMHandle | This field is editable through the web API. | String | This field is nullable. | The Instant Messenger (IM) username/handle associated with the new user. | |
| LocationID | This field is editable through the web API. | Int32 | The ID of the location associated with the user. | ||
| LocationRoomID | This field is editable through the web API. | Int32 | The ID of the location room associated with the user. |