ClientPortalUsers

This entity describes an Autotask Company Contact that has been assigned access to the Client Access Portal. In the Autotask Interface, Company Contacts are enabled as Client Portal Users in Admin > Client Access Portal > Manage Companies > select Company > "Manage users for this account" or from the Client Portal tab of the Edit Contact window.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: ClientPortalUsers

Entity Path:

/atservicesrest/v1.0/ClientPortalUsers
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 fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
contactID integer Contacts  
dateFormat integer    
id long    
isClientPortalActive boolean      
numberFormat integer    
password string (50)        
securityLevel integer    
timeFormat integer    
userName string (200)      

Additional resources