Checking Key Availability in HSM

CA Strong Authentication Web Services Guide › Managing AuthMinder Configurations › Checking Key Availability in HSM

Checking Key Availability in HSM

The isKeyAvailableInHSM operation is used to check if the key is present in the HSM. This section walks you through the following topics for checking the HSM keys:

Preparing the Request Message
Invoking the Web Service
Interpreting the Response Message

Note: After you delete configurations, you must refresh the system cache for the changes to take effect. See "Refreshing the Organization Cache" for more information on how to refresh the system cache.

Preparing the Request Message

The isKeyAvailableInHSMRequest message is used to check the key in HSM. The following table lists the elements of this request message.

Element	Mandatory	Description

clientTxId	No	Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.
Additional Input (additionalInput) Elements
pairs	No	AuthMinder’s additionalInput element enables you to set additional inputs if you want to augment AuthMinder’s authentication capability by specifying additional information. In such cases, you need to set the extra information in name-value pairs. name (The name with which you want to create the key pair.) value (The corresponding value for name.) Note: You can add more than one of these elements. Some of the pre-defined additional input parameters include: AR_WF_LOCALE_ID Specifies the locale that AuthMinder will use while returning the messages back to your calling application. AR_WF_CALLER_ID This is useful in tracking transactions. You can use session ID or client transaction ID (clientTxnId) for specifying this information.
Key Details
keyLabel	Yes	The label of the key that refers to the key that is available in the HSM.

Invoking the Web Service

To delete configuration details:

(Optional) Include the authentication and authorization details in the SOAP header or in the additionalInput element of the isKeyAvailableInHSM operation. See chapter, "Managing Web Services Security" for more information on these details.
Use the isKeyAvailableInHSMRequest elements to check the key details, as listed in the preceding table.
Use the isKeyAvailableInHSMRequest message and construct the input message by using the details obtained in the preceding step.
Invoke the isKeyAvailableInHSM operation of the ArcotWebFortAdminSvc service to delete the configuration details.

Interpreting the Response Message

For successful transactions, the response message, isKeyAvailableInHSMResponse returns the elements explained in the preceding table. These elements are included in the SOAP body. If there are any errors, then the Fault response is included in the SOAP body. See appendix, "Error Codes" for more information on the SOAP error messages.

Element	Description
message	Indicates the status of the transaction.
reasonCode	Unique code that is sent by AuthMinder Server if the operation fails.
responseCode	Code returned by the SDK in case of errors.
transactionID	The unique identifier of the transaction.
additionalOutput	The return values corresponding to the additional input.