Update Protocol Public Key

The UpdateProtocolPublicKey command action is used to update a protocol public Key. To use the UpdateProtocolPublicKey action command, you must have UpdatePublicKeyRight. For more information on this right, see AddUserToRole.

Parameter Description Default Required
CreateAdd (ca) Creates or adds a key. Valid values are as follows:
  • Create - Creates a key. Shows an error if a public key exists for a user or a server.
  • Add - Adds a key even if a key exists for a user or a server.
Create Y
Description Description of the protocol public key to be updated. N/A N
KeyId (id) Key type ID defines the 12 digit key ID associated with the protocol public key.

Example: K205G0000BC9

N/A Y
PublicKey (pk) Public key to be added. The key should be without line separators and without spaces. N/A Y*1
PublicKeyFileName (pkfn) Name of the file that contains the protocol public key N/A Y*1
Status (st) Key status when added:
  • Enabled
  • Disabled
N/A N
  • 1 - PublicKeyFileName and PublicKey parameters are mutually exclusive.