Previous Topic: Checking Key Availability in HSMNext Topic: Performing Credential Operations


Deleting Configurations

The delete operation is used to delete configurations in AuthMinder. After you delete a configuration, the information related to that configuration is still maintained in the system. Therefore, you cannot create a configuration profile with the same name as that of a deleted one. This section walks you through the following topics for deleting configurations:

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 deleteRequest message is used to delete configurations. The following table lists the common elements of this request message that are applicable to all credentials and authentication policies.

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.

Organization Detail (configurationNames/orgDetails) Elements

orgName

Yes

Deletes the name of the organization to which you applied the configuration settings.

OR

isGlobal

Yes

Indicates if you want to apply these configuration settings at the global level.

Credential and Authentication Configuration Elements

The following elements are applicable to all credential and authentication policy configurations.

configNames

No

Deletes the configuration names for a particular organization.

isAllConfigs

No

Indicates whether all configurations must be deleted.

Invoking the Web Service

To delete configuration details:

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

Interpreting the Response Message

For successful transactions, the response message, deleteResponse returns the elements explained in the following 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.