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

Enabling Credentials

The enable method is used to activate the disabled or locked credential of a user. For example, a credential can be disabled or locked if a user tries to authenticate by using the wrong credential or exceeds the configured maximum number of allowed attempts.

To enable a credential:

1. Depending on the type of credential you want to enable, 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 enable() method of the CredentialIssuance interface to enable 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.