ClientPortalUser

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

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.
There are two Client Portal user security levels that allow access to Taskfire features: Resource (value = 4) and Administrator (value = 5). Query the ClientPortalUser entity for users with these security levels to return users that have access to Taskfire.
The ClientPortalUsers entity does not allow assignment of Taskfire SecurityLevel values to contacts that do not have Taskfire access.

Password

Required on create()
Not required on update() performed on existing ClientPortalUser. If password is set, then we will store in DB. Query will never return the Password field as part of the entity returned (it will always be null). 
To update for an existing entity, set the Password field to the new password to be stored on update().
Must enforce the following restrictions: 1) allows printable characters except single quotes, 2) must be between 5-50 characters, 3) cannot contain spaces.

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)