Inserts or creates a user account record.
Parameters
insertUserAccount Parameter Descriptions
Parameter Name |
Data Type |
Description |
userAccount |
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). |
groupAccountAddUniqueKeys |
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
