Previous Topic: Fetching QnA ConfigurationNext Topic: Fetching ArcotID PKI Key Bag Elements


Adding Elements to ArcotID PKI Key Bag

ArcotID PKI can also be used to securely store the Open PKI keys and certificates. These keys are typically used for different applications or operations such as, email signing (S/MIME), document signing, and certificate-based authentication (open PKI).

The location where the open PKI keys and certificates are stored in the ArcotID PKI is called key bag or key vault.

To add elements to ArcotID PKI key bag, you need to implement the addElements() method in the ArcotIDKBMIssuance interface.

  1. Use the ArcotIDKeyBagElementSelection and ArcotIDKeyBagElementSet classes to obtain the elements that you need to add to the key bag.
  2. (Optional) If you are implementing a plug-in, then invoke the setAdditionalInput() method in the AdditionalInput class to fill the AdditionalInput.

    This class provides the additional information that is set as a name-value pair. See "Preparing Additional Input" for more information.

  3. Invoke the addElements() method of the ArcotIDKBMIssuance interface to add elements to the ArcotID PKI key bag.

    This method returns an instance of the TransactionDetails interface, which specifies the transaction ID, message, response code, and reason code.

Handling Errors

Exceptions are returned for any errors that occurred while executing any of the Issuance API methods. The com.arcot.webfort.issuance.api.exception and com.arcot.webfort.common.api.exception packages contain these exceptions. See "Issuance Exceptions" and "Common Exceptions" for more information on exception classes.

Note that if no exception is thrown, then processing was successful and the return object can be referenced for processing results. The lack of an error does not necessarily mean that the request was successful.