AddAdminUser

The AddAdminUser command action is used to define an administrative user to the TIBCO MFT Command Center system.

This user is automatically assigned the administrator right.

In the following table, parameters for this command are provided in alphabetical order.
Note: The parameters provided in this table are also used for the UpdateUser command.
Parameter Description Default Required
AddPGPKey (paddk) Specifies whether to allow a user to add a PGP key.
The valid values are as follows:
  • Y
  • N
  • D: default
D No
AllowableProtocol Specifies the protocol that the user will be allowed to use for a file transfer.
The valid values are as follows:
  • FTP
  • Secure FTP: referred as SECUREFTP.
  • HTTPS
  • CF: for TIBCO MFT Platform Server.
  • Secure
  • AS2
  • SSL/TLS (for MFT 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
CanChangePassword Specifies whether to allow this user to change password.
The valid values are as follows:
  • Y
  • N
Y No
CertificateDN Specifies the 1 to 1024 character certificate distinguish name of the user. 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
ChangePasswordNextLogin Specifies whether this user have to change password at the next logon.
The valid values are as follows:
  • Y
  • N
Y No
Company Name (cname) Specifies the 1 to 64 character company name. None No
DefaultRole Specifies the default role of the user. None No
Department Specifies the department the user will be placed in. None No
Description Specifies the 1 to 256 character description for this user.

If the description contains embedded spaces, the entire description must be enclosed in double quotation marks (").

None No
DisableFlag Specifies whether this user is initially disabled from the TIBCO MFT Command Center system.
The valid values are as follows:
  • Y
  • N
N No
EmailAddr Specifies the 1 to 64 character email address of the user. None No
EndDate Specifies the date when the account of this user will become inactive in the TIBCO MFT Command Center system.

The format is YYYY/MM/DD.

The date range is 2000/01/01 to 2099/12/31.

None Yes
ExpirationDate Specifies the date when the account of this user will be expired from the TIBCO MFT Command Center system.

The format 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 Specifies the 1 to 256 character name for this user.

If the full name contains embedded spaces, the entire full name must be enclosed in 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) Specifies the 1 to 64 character machine name or IP address.

If the RestrictUser parameter is configured as Y, this parameter is required.

None No
LockFlag Specifies whether to lock the user out of the TIBCO MFT Command Center system.
The valid values are as follows:
  • Y
  • 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) Specifies the 1 to 64 byte netmask. None No
Password Specifies the 1 to 30 character password assigned to this user.

The password cannot contain any embedded spaces. It is case sensitive.

None Yes
PasswordNeverExpires Specifies whether this password ever expires.

This parameter overrides the global password rules.

The valid values are as follows:
  • Y
  • N
N No
PhoneNumber (phone) Specifies the 1 to 64 character telephone number. None No
RestrictUser (rus) Specifies whether to restrict this user.
The valid values are as follows:
  • Y
  • 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 Specifies the date when this user will be active in the TIBCO MFT Command Center system.

The format is YYYY/MM/DD.

The date range is 2000/01/01 to 2099/12/31.

None Yes
TraceLevelFlag Specifies the trace level of the flag. The values supported for this parameter are as follows:
  • 0: no tracing
  • 1-5 and 10: different levels of tracing

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
UserId Specifies the 1 to 64 character ID to be assigned to this user.

The user ID cannot contain embedded spaces.

Note: The user ID can be defined in both uppercase and lowercase, but it will be stored in uppercase in the TIBCO MFT Command Center database.
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 Command Center system.

For example, the first character represents Sunday, the second on represents Monday.

Each character can be Y or N.

None Yes
ValidEndTime Specifies a time in military format HHMM when TIBCO MFT Command Center will no longer allow this user access. None Yes
ValidStartTime Specifies a time in military format HHMM when this user can start using TIBCO MFT Command Center. None Yes
Visibility Specifies the visibility of the user.
The valid values are as follows:
  • PUB: public
  • PRI: private
PRI Yes

Sample AddAdminUser Command

This command adds a user to the TIBCO MFT Command Center user database.

java cfcc.CFAdmin a:AddAdminUser UserId:CenterAdmin101 FullName:"MFT Command Center Admin" Password:101 LockFlag:N ExpirationDate:2009/12/31 Description:"MFT Command Center Admin 101" StartDate:2005/01/03 EndDate:2006/07/01 ValidDays:NYYYYYN ValidStartTime:1700 ValidEndTime:2100 AllowableProtocol:All