Previous Topic: Creating CredentialsNext Topic: Enabling Credentials

CA AuthMinder Java Developer's Guide › Performing Issuance Operations › Credential Operations › Disabling Credentials

Disabling Credentials

User credentials can be disabled for a specified time interval. For example, if an employee goes for long vacation, then the credentials of this user can be disabled to prevent any unauthorized access during their absence.

To disable credentials:

  1. Depending on the type of credential you want to disable, use the respective <CredentialName>Input class to obtain an object that implements the class.

    The input required for each credential is different. For example, password is needed for password as well as ArcotID PKI credential, while questions and corresponding answers are required for QnA credentials.

    Note: See "Credential Operations Summary" for the input details required by different credentials.

  2. Use the CredentialInput abstract class to obtain the methods that set the common information of the credential.
  3. Invoke the CredentialInputList class to pass the input classes of different credentials.
  4. (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.

  5. Invoke the disable() method of the CredentialIssuance interface to disable the credentials.

    This method returns an instance of the CredentialResponse interface, which specifies the details of all credentials and the transaction.

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.