UserAccountRepository Method Details

insertUserAccount

Inserts or creates a user account record.

Parameters
insertUserAccount Parameter Descriptions

Parameter Name	Data Type	Description
userAccount	userAccountCreate	Data object

Required Properties from userAccountCreate

The following table lists properties from the userAccountCreate data object that must be populated in order to create a user account record. Also note that the same properties must be populated when you are updating a user account record, using the userAccountUpdate data object.

userAccountCreate Required Properties

Property Name	Data Type	Description
username	string	The user name (this will be used to log into the application UI). Maximum length: 50 characters.
password	string	The user's password. Maximum length: 250 characters
contactUniqueKey	string	The corresponding contact record's unique key. Each user must have an associated contact record.
userType	userType	Although this property is not required to create a user account, it is highly recommended to populate it. Super—Can access all public and private records. This setting overrides access restrictions based on record-level security settings. Recommended for system administrators and solution developers. Normal—Can access all public records. Can access private records only if created by the user or if record-level security is granted to the user. Recommended for internal staff. Limited-Privilege—Can access only records created by the user, records where the user is an assignee or attendee, and records with record-level security granted to the user. Recommended for Outside Counsel. Note: Access to a record automatically grants access to its embedded records but not to its related records. For example, if a limited-privilege user has the right to access a dispute record, they cannot automatically access the dispute's related involved parties, tasks, histories, or expenses, but they can access its allegation (embedded object) records.
active	boolean	Although this property is not required to create a user account, it is highly recommended to populate it. Status of account activation (true indicates the account is active).
groupAccountAddUnique Keys	List<String>	Although this property is not required to create a user account, it is highly recommended to populate it. List of unique keys for group records that the current user should be added to

Response

insertUserAccount Response Descriptions

Parameter Name	Data Type	Description
uniqueKey	string	The unique key of the newly created user account record.

See Also:
userAccountCreate for more information about the properties you can set for the user userType for more information about the properties you can set for the user

updateUserAccount

Updates a user account record.

When you send an updateUserAccount request, certain contact property values must be populated. For more information, see the userAccountCreate Required Properties table.

Parameters
updateUserAccount Parameter Descriptions

Parameter Name	Data Type	Description
userAccount	userAccountUpdate	Data object

Response
None

See Also:
userAccountUpdate for more information about the properties you can set for the user

readUserAccount

Gets requested properties for an existing user account given its unique key.

Parameters
readUserAccount Parameter Descriptions

Parameter Name	Data Type	Description
uniqueKey	string	Unique key of the record to read.
properties	List<String>	A list of String values that identify the property names whose values to return with the resulting user account record.

Response

readUserAccount Response Descriptions

Parameter Name	Data Type	Description
userAccount	userAccount	A user account record. Only specified property values are returned with the record.

See Also:
userAccount for more information about the properties you can retrieve for the user

readUserAccountsByCriteria

Retrieves a set of user accounts based on specified search criteria. If the criteria is empty, then the search will retrieve all user accounts. The specified limit takes precedence over the current system setting for the maximum number of search results. For a list of available properties, see the type class, userAccount.

Parameters
readUserAccountsByCriteria Parameter Descriptions

Parameter Name	Data Type	Description
criteria	searchCriteria	Search criteria or conditions to search for.
limit	int	A numeric value for the maximum number of records to return among search results.
properties	List<String>	A list of String values that identify the property names whose values to return with the resulting user account records.

Response

readUserAccountsByCriteria Response Descriptions

Parameter Name	Data Type	Description
userAccounts	List<userAccount>	A list of user account objects. Only specified property values are returned with the record.

See Also:
userAccount for more information about the properties you can retrieve

deleteUserAccount

Deletes the user account specified by the unique key.

Parameters
deleteUserAccount Parameter Descriptions

Parameter Name	Data Type	Description
uniqueKey	string	Unique key of the record to delete.

Response
There is no return value.

readRecentlyViewedUserAccounts

Read recently viewed user accounts.

Parameters
readRecentlyView edUserAccounts Parameter Descriptions

Parameter Name	Data Type	Description
properties	List<String>	A list of String values that identify the property names whose values to return with the resulting user account records.

Response

readRecentlyView edUserAccounts Response Descriptions

Parameter Name	Data Type	Description
userAccounts	List<userAccount>	A list of user account objects. Only specified property values are returned with the record.