| name (type) |
min/max
occurs |
description |
|
userName (string)
|
0/1 |
Unique login user name. Required field.
|
|
status (userStatusType)
|
0/1 |
User status type. See userStatusType.
|
|
password (string)
|
0/1 |
User password. Only used on initial creation. Passwords are converted to an MD5 string and then persisted.
|
|
firstName (string)
|
0/1 |
User first name. Required field.
|
|
lastName (string)
|
0/1 |
User last name. Required field.
|
|
company (string)
|
0/1 |
Company for which the user works for.
|
|
address (string)
|
0/1 |
User address.
|
|
address2 (string)
|
0/1 |
User address line 2.
|
|
city (string)
|
0/1 |
User city.
|
|
state (string)
|
0/1 |
User state or province.
|
|
altPhone (string)
|
0/1 |
User alternate phone number.
|
|
zip (string)
|
0/1 |
User ZIP or Postal code.
|
|
country (string)
|
0/1 |
User country code.
|
|
phone (string)
|
0/1 |
User phone number.
|
|
fax (string)
|
0/1 |
User fax number.
|
|
email (string)
|
0/1 |
User email address. Required field.
|
|
lastLogin (long)
|
0/1 |
User last login date timestamp.
|
|
creation (long)
|
0/1 |
Date user was created.
|
|
preferredServer (nameHrefModel)
|
0/1 |
User preferred FTP server.
|
|
creditCardType (string)
|
0/1 |
User credit card type.
|
|
creditCardNumber (string)
|
0/1 |
User credit card number.
|
|
creditCardExpiry (string)
|
0/1 |
User credit card expiry date.
|
|
accountStatus (userAccountStatusType)
|
0/1 |
User account status type. See userAccountStatusType.
|
|
comment (string)
|
0/1 |
User comment.
|
|
admin (boolean)
|
0/1 |
Flag to indicate that the user is an administrator.
|
|
superAdmin (boolean)
|
0/1 |
Flag to indicate that the user is an super administrator.
|
|
acceptEmail (boolean)
|
0/1 |
Flag to indicate that the user accepts emails.
|
|
allowHotFolder (boolean)
|
0/1 |
Flag to indicate that the user is allowed Job Submission through HotFolder/Outlook/API.
|
|
protocol (userProtocolType)
|
0/1 |
User preferred protocol to use. See userProtocolType.
|
|
bandwidth (string)
|
0/1 |
Value in kbps. The user is prevented from exceeding this bandwidth.
Default is 0, which signifies no limit; maximum bandwidth is therefore the speed of the FileCatalyst server.
|
|
directory (boolean)
|
0/1 |
Flag to indicate if the user is part of an LDAP directory server.
Read only attribute.
|
|
slowStartRate (string)
|
0/1 |
Slow start rate.
|
|
useSlowStart (boolean)
|
0/1 |
Flag to indicate if the slow start rate should be used.
|
|
slowStartAggressionRate (string)
|
0/1 |
Slow start aggression rate.
|
|
blocksize (string)
|
0/1 |
Value in bytes - default 4096000.
The block size determines how much data will be stored, encoded and sent from the transmitter to the receiver
at one time in any one thread. The transmitter waits for acknowledgment that a block is received before proceeding
to the next block; therefore the larger the block size, the better the throughput due to fewer acknowledgments.
However, poorly-performing networks may cause excessive retransmission of lost data if the block size is overly large.
|
|
unitSize (string)
|
0/1 |
Value in bytes - default 1024.
The maximum UDP packet size that client applications can send to the server.
Generally this should be less than the MTU of your network (usually 1500).
|
|
numEncoders (string)
|
0/1 |
Number of encoders.
|
|
numFTPStreams (string)
|
0/1 |
Number of FTP streams.
|
|
allowUserBandwidthTuning (boolean)
|
0/1 |
Flag to indicate that the user is allowed bandwidth tuning.
|
|
expiryDate (long)
|
0/1 |
User account expiry date.
|
|
allowTempAccountCreation (boolean)
|
0/1 |
Flag to indicate that the user is allowed to create temporary accounts.
|
|
ownerUserName (string)
|
0/1 |
Owner user name
|
|
tempUser (boolean)
|
0/1 |
Temporary user flag.
|
|
uploadMethod (userUploadMethodType)
|
0/1 |
User preferred upload method to use. See userUploadMethodType.
|
|
pwChangeable (boolean)
|
0/1 |
Flag to indicate id the user is allowed to change his/her password.
|
|
pwcreationDate (long)
|
0/1 |
Date password was created.
|
|
pwdaysBeforeExpire (long)
|
0/1 |
Days before password will expire.
|
|
pwmustChange (boolean)
|
0/1 |
Flag to indicate that the user must change his/her password on the next login.
|
|
pwusedPasswords (string)
|
0/1 |
Previously used passwords.
|
|
pwnumErrors (int)
|
0/1 |
Password error attempts.
|
|
group (nameHrefModel)
|
0/unbounded |
List of groups for which the user belongs to
|
| property |
type |
description |
| href |
string |
Hyperlink reference to the resource
|
| userName |
userName (string)
|
Unique login user name. Required field.
|
| status |
status (userStatusType)
|
User status type. See userStatusType.
|
| password |
password (string)
|
User password. Only used on initial creation. Passwords are converted to an MD5 string and then persisted.
|
| firstName |
firstName (string)
|
User first name. Required field.
|
| lastName |
lastName (string)
|
User last name. Required field.
|
| company |
company (string)
|
Company for which the user works for.
|
| address |
address (string)
|
User address.
|
| address2 |
address2 (string)
|
User address line 2.
|
| city |
city (string)
|
User city.
|
| state |
state (string)
|
User state or province.
|
| altPhone |
altPhone (string)
|
User alternate phone number.
|
| zip |
zip (string)
|
User ZIP or Postal code.
|
| country |
country (string)
|
User country code.
|
| phone |
phone (string)
|
User phone number.
|
| fax |
fax (string)
|
User fax number.
|
| email |
email (string)
|
User email address. Required field.
|
| lastLogin |
lastLogin (long)
|
User last login date timestamp.
|
| creation |
creation (long)
|
Date user was created.
|
| preferredServer |
preferredServer (nameHrefModel)
|
User preferred FTP server.
|
| creditCardType |
creditCardType (string)
|
User credit card type.
|
| creditCardNumber |
creditCardNumber (string)
|
User credit card number.
|
| creditCardExpiry |
creditCardExpiry (string)
|
User credit card expiry date.
|
| accountStatus |
accountStatus (userAccountStatusType)
|
User account status type. See userAccountStatusType.
|
| comment |
comment (string)
|
User comment.
|
| admin |
admin (boolean)
|
Flag to indicate that the user is an administrator.
|
| superAdmin |
superAdmin (boolean)
|
Flag to indicate that the user is an super administrator.
|
| acceptEmail |
acceptEmail (boolean)
|
Flag to indicate that the user accepts emails.
|
| allowHotFolder |
allowHotFolder (boolean)
|
Flag to indicate that the user is allowed Job Submission through HotFolder/Outlook/API.
|
| protocol |
protocol (userProtocolType)
|
User preferred protocol to use. See userProtocolType.
|
| bandwidth |
bandwidth (string)
|
Value in kbps. The user is prevented from exceeding this bandwidth.
Default is 0, which signifies no limit; maximum bandwidth is therefore the speed of the FileCatalyst server.
|
| directory |
directory (boolean)
|
Flag to indicate if the user is part of an LDAP directory server.
Read only attribute.
|
| slowStartRate |
slowStartRate (string)
|
Slow start rate.
|
| useSlowStart |
useSlowStart (boolean)
|
Flag to indicate if the slow start rate should be used.
|
| slowStartAggressionRate |
slowStartAggressionRate (string)
|
Slow start aggression rate.
|
| blocksize |
blocksize (string)
|
Value in bytes - default 4096000.
The block size determines how much data will be stored, encoded and sent from the transmitter to the receiver
at one time in any one thread. The transmitter waits for acknowledgment that a block is received before proceeding
to the next block; therefore the larger the block size, the better the throughput due to fewer acknowledgments.
However, poorly-performing networks may cause excessive retransmission of lost data if the block size is overly large.
|
| unitSize |
unitSize (string)
|
Value in bytes - default 1024.
The maximum UDP packet size that client applications can send to the server.
Generally this should be less than the MTU of your network (usually 1500).
|
| numEncoders |
numEncoders (string)
|
Number of encoders.
|
| numFTPStreams |
numFTPStreams (string)
|
Number of FTP streams.
|
| allowUserBandwidthTuning |
allowUserBandwidthTuning (boolean)
|
Flag to indicate that the user is allowed bandwidth tuning.
|
| expiryDate |
expiryDate (long)
|
User account expiry date.
|
| allowTempAccountCreation |
allowTempAccountCreation (boolean)
|
Flag to indicate that the user is allowed to create temporary accounts.
|
| ownerUserName |
ownerUserName (string)
|
Owner user name
|
| tempUser |
tempUser (boolean)
|
Temporary user flag.
|
| uploadMethod |
uploadMethod (userUploadMethodType)
|
User preferred upload method to use. See userUploadMethodType.
|
| pwChangeable |
pwChangeable (boolean)
|
Flag to indicate id the user is allowed to change his/her password.
|
| pwcreationDate |
pwcreationDate (long)
|
Date password was created.
|
| pwdaysBeforeExpire |
pwdaysBeforeExpire (long)
|
Days before password will expire.
|
| pwmustChange |
pwmustChange (boolean)
|
Flag to indicate that the user must change his/her password on the next login.
|
| pwusedPasswords |
pwusedPasswords (string)
|
Previously used passwords.
|
| pwnumErrors |
pwnumErrors (int)
|
Password error attempts.
|
| group |
array of group (nameHrefModel)
|
List of groups for which the user belongs to
|