Previous Topic: Reissuing CredentialsNext Topic: Resetting Custom Attributes


Resetting Credential Validity

Issued credentials are valid for the period that is specified at the time they are created. The CredentialIssuance interface provides resetValidity() method, which helps to reset the validity period of the credential before it expires. This method is used to either extend or reduce the validity period of the credential, but it does not reset the password or any other credential attributes.

To reset the validity of the credential:

  1. Depending on the type of credential that has to be reset, 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 resetValidity() method of the CredentialIssuance interface to reset the validity of the credential.

    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.