UpdateUser

The UpdateUser command action is used to alter an existing user in the TIBCO MFT Internet Server system.

Note: UpdateUser and AddAdminUser commands have common parameters. For UpdateUser command parameters, see AddAdminUser.
Parameter Description Default Required
AddPGPKey (paddk) Allow a user to add a PGP key. The values supported for this parameter are as follows:
  • Y
  • N
  • D

The default value is D.

D No
AllowableProtocol (apl) The protocol the user is allowed to use in a file transfer. The values supported for this parameter are as follows:
  • FTP
  • Secure FTP (referred as SECUREFTP)
  • HTTPS
  • CF (Platform Server)
  • Secure
  • AS2
  • SSL/TLS (Platform Server)
  • All (includes all listed protocols except AS2)
All No
AssignedGroups Specifies the groups that a user has to be added to. Add groups between double quotation marks ("") and use a semi-colon (;) as delimiter. None No
AssignedRights Specifies the rights that have to be assigned to a user. A transfer right is assigned by default. Add rights between double quotation marks ("") and use a semi-colon (;) as delimiter. None No
CFAuthType Specifies the type of authentication for CF transfers. The values supported for this parameter are as follows:
  • 1: password only
  • 2: certificate only
  • 3: certificate or password
  • 4: certificate and password
None No
CanChangePassword Specifies whether to allow this user to change password. The valid values are Y and N. Y No
CertificateDN The user’s certificate distinguish name. The maximum value is up to 1024 characters. None No
ChangePasswordNextLogin Specifies whether this user have to change his/her password the next time they log on. The valid values are Y and N. Y No
Company Name (cname) The 1 – 64 character company name. None No
DefaultGroup Specifies the group into which a user is added. None No
DefaultRole The user’s default role. None No
Department The department the user is placed in. None No
Description Description for this user.

The description can contain embedded blanks but must be enclosed within double quotation marks (" "). The maximum value is up to 256 characters.

None No
DisableFlag Specifies whether this user is initially disabled from the TIBCO MFT Internet Server system. The valid values are Y and N. N No
EmailAddr Specifies the user’s email address. The maximum length is 64 characters. None No
EndDate The date when this user’s account becomes inactive in the TIBCO MFT Internet Server System. The format for this parameter is YYYY/MM/DD. The date range is 2000/01/01 to 2099/12/31. None Yes
ExpirationDate The date when this user’s account is expired from TIBCO MFT Internet Server system. The format for this parameter is YYYY/MM/DD. The date range is 2000/01/01 to 2099/12/31. None Yes
FTPAuthType Specifies the type of authentication for FTP transfers. The values supported for this parameter are as follows:
  • 1: password only
  • 2: certificate only
  • 3: certificate or password
  • 4: certificate and password
None No
FullName The 1 to 256 character name for this user.

The FullName parameter can contain embedded blanks but must be enclosed within double quotation marks (" ").

None Yes
HTTPSAuthType Specifies the type of authentication for HTTPS transfers. The values supported for this parameter are as follows:
  • 1: password only
  • 2: certificate only
  • 3: certificate or password
  • 4: certificate and password
None No
IPName (ipn) The 1-64 character machine name or IP address. (Required if RestrictUser=Y) None No
LockFlag Specifies whether the user is initially locked out of the TIBCO MFT Internet Server system. The valid values are Y and N. None No
ManageDepartments Specifies the departments to be managed separated by a semicolon (;). None No
MaxFileSize Specifies the maximum size of a file. None No
Netmask (netm) The 1 - 64 byte netmask. None No
Password The 1 to 30 character password assigned to this user.

The Password parameter cannot contain any embedded blanks. It is case sensitive.

None Yes
PasswordNeverExpires Specifies whether this password can ever expire. (Overrides the Global Password Rules)

The valid values are Y and N.

N No
PhoneNumber (phone) The 1 - 64 character telephone number. None No
RestrictUser (rus) Restrict this user.

The valid values are Y and N.

N No
SSHAuthType Specifies the type of authentication for SSH transfers. The values supported for this parameter are as follows:
  • 1: password only
  • 2: certificate only
  • 3: certificate or password
  • 4: certificate and password
None No
StartDate The date when this user becomes active in the TIBCO MFT Internet Server System. Format-YYYY/MM/DD. The date range is 2000/01/01 to 2099/12/31. None Yes
TraceLevelFlag This flag should only be set under instruction from TIBCO Technical Support. 0 No
Usage Specifies the type of usage. The values supported for this parameter are as follows:
  • 0: non-file share user
  • 1: file share user
  • 2: mailbox user
None No
UserHomeDirectory Specifies the home directory of a user. None No
UserId Specified the 1 to 64 character ID assigned to a user. The UserId parameter can not contain embedded blanks.
Note: The UserId can be defined in both upper and lower case, but it is stored in the TIBCO MFT Internet Server database in uppercase.
None Yes
UserType Specifies the type of file share user only. This parameter is only applicable if usage is a file share user. The values supported for this parameter are as follows:
  • 1: guest
  • 2: full user
  • 3: power user
None No
ValidDays Specifies a 7 character day of week pattern when the user can access the TIBCO MFT Internet Server system, Sunday being the first character, Monday the second, and so on. where each character can be Y or N. None Yes
ValidEndTime Specifies a time in military format HHMM when TIBCO MFT Internet Server no longer allows this user access. None Yes
ValidStartTime Specifies a time in military format HHMM when this user can start using TIBCO MFT Internet Server. None Yes
Visibility The user’s visibility. The values supported for this parameter are as follows:
  • PUB: public.
  • PRI: private.
PRI Yes

Sample UpdateUser Command

This command updates user TIBCO MFT Internet Server User001 to allow access to the TIBCO MFT Internet Server system on weekends and only from 1 a.m. to 9 a.m.

java cfcc.CFAdmin a:UpdateUser UserId:User001 ValidDays:YNNNNNY ValidStartTime:0100 ValidEndTime:0900 AllowableProtocol:All