User object

Table 1. Attributes for the user object
Name Description DataType Required Default value Possible values Updateable
name Name of the user nameString Yes  
  • User name
  • "_ALL"
 Yes
uid User ID value Integer No 0
  • Integer value 1–1,080,000
  • 0 to indicate system generated values
 No
description Description of the user descString No ""   Yes
password User's password passwordString No ""   Yes
userType Type of user userTypeString No "User"
  • "User"
  • "User Admin"
  • "AG/Folder/Cabinet Admin"
  • "Hold Admin"
  • "System Admin"
  • "System Admin (Read-Only)"
 Yes
timeOut Time out length in minutes timeOutType No "Use System Value"
  • "Use System Value"
  • "No Limit"
  • Any positive integer value
 Yes
fullName User's full name userMiscString No ""   Yes
acctInfo Accounting for the user userMiscString No ""   Yes
company Name of the company userMiscString No ""   Yes
title User's title of job responsibility userMiscString No ""   Yes
addr1 User's address userMiscString No ""   Yes
addr2 Address, line number 2 userMiscString No ""   Yes
addr3 Address, line number 3 userMiscString No ""   Yes
addr4 Address, line number 4 userMiscString No ""   Yes
dept User's department name or number userMiscString No ""   Yes
building User's building name or number userMiscString No ""   Yes
room User's office name or number userMiscString No ""   Yes
phone User's phone number phoneString No ""   Yes
fax User's fax number phoneString No ""   Yes
email User's email address emailString No ""   Yes
coverPage Default Fax cover page for the user userMiscString No ""   Yes
printer User's default printer nameString No "NONE"   Yes
createCabinetsAuth Whether this user or group has authority to create cabinets yesnoString No "No"
  • "Yes"
  • "No"
 Yes
createFoldersAuth Whether this user have authority to create folders yesnoString No "No"
  • "Yes"
  • "No"
 Yes
createHoldsAuth Whether this user has authority to create holds yesnoString No "No"
  • "Yes"
  • "No"
 Yes
createUsersAuth Whether this user has authority to create users yesnoString No "No"
  • "Yes"
  • "No"
 Yes
createGroupsAuth Whether this user have authority to create group yesnoString No "No"
  • "Yes"
  • "No"
 Yes
createAppGroupsAuth Whether this user have authority to create application groups yesnoString No "No"
  • "Yes"
  • "No"
 Yes
disableUser Specifies whether this user should be disabled yesnoString No "No"
  • "Yes"
  • "No"
 Yes
passwordExp Specifies when the user's password expires pwExpValue No "Use System Value"
  • "Use System Value"
  • "Never Expires"
  • An integer between 1 and 365
 Yes
printerClass The printer class char No ""   Yes
printerBanner Specifies whether there should be a printer banner yesnoString No "No"
  • "Yes"
  • "No"
 Yes
printerDest The printer destination valString No ""   Yes
printerNode The printer node valString No ""   Yes
printerWriter The printer writer valString No ""   Yes
printerPagedef The printer pagedef valString No ""   Yes
printerFormdef The printer formdef valString No ""   Yes
printerForms The printer forms valString No ""   Yes
printerRouting The printer routing routingString No ""   Yes
Table 2. Child object under the user object
Name Minimum number Maximum number Deleteable Updateable
permission 0 Unbounded Yes Yes
Table 3. Attributes for the permission object under the user object
Attributes Description Datatype Required Default Value Possible Values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
user The name of a user that can view and maintain this user nameString Yes ""
  • User name
 No
group The name of a group that can view and maintain this user nameString Yes ""
  • Group name
 No
adminAuthority Whether this user or group has authority to update and delete the user yesnoString No "No"
  • "Yes"
  • "No"
 Yes
Remember: The "_ALL" value can only be used in an ARSXML export operation.

In the permission child, you must specify either a user or a group object, however, you cannot specify both.