ClientPortalUser
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
This entity describes an Autotask Account Contact that has been assigned access to the Client Access Portal. In the Autotask Interface, Account Contacts are enabled as Client Portal Users in Admin > Client Access Portal > Manage Accounts > select Account > "Manage users for this account" or from the Client Portal tab of the Edit Contact window.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
Entity Name: | ClientPortalUser |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Fields that cannot be queried
The following fields from this entity will return an error when queried.
- Password
Conditions and requirements
Special field attributes
Field | Conditions and Requirements |
---|---|
ContactID |
ContactID cannot be modified once created. |
UserName |
UserName must be unique. |
SecurityLevel |
SecurityLevel refers to Client Access Portal security levels. |
Password |
Required on create() |
Field definitions
The following table describes the standard Autotask field objects for this entity.
- To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
- For information on entity UDFs, use getUDFInfo().
- For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
For more information about fields marked as picklists, review our Understanding picklists article.
Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|---|
ClientPortalActive | Client Portal Active | boolean | ||||
ContactID | Contact ID | integer | Contact | |||
DateFormat | Date Format | integer | ||||
id | Client Portal User ID | long | ||||
NumberFormat | Number Format | integer | ||||
Password | Password | string (50) | ||||
SecurityLevel | Security Level | integer | ||||
TimeFormat | Time Format | integer | ||||
UserName | User Name | string (200) |