Previous Topic: Preparing the InputNext Topic: Credential-Specific Input


Common Input

The CredentialInput interface provides the common configurations to all the credential types. The following information is set by using this interface:

Validity

The Issuance API enables you to set a period for which the credential will be valid. Invoke the setValidity() method of the CredentialInput class if you want to pass a specific calendar date, or use setValidityEx() class if you want to use the ArcotDate.Type Class to set the validity date.

The validity of the credential is taken as input by resetValidity() methods.

Custom Attributes

The Issuance API enables you to add custom attributes for each credential type. This feature helps you to maintain any additional credential information. For example, if you do not want the user to download their ArcotID PKI on more than five systems, then you can create an attribute with this information. This is taken as input by create() or resetNotes() methods.

To add custom attributes, invoke the setNote() method of the CredentialInput class.

Profile Name

Typically, same set of credential information could well be applied to many users. In such cases, to avoid the cumbersome task of entering the credentials for each user individually, you can create a profile with all common information and share this profile among multiple users. Each profile is identified by a unique Profile Name.

The Issuance API enables you to set the profile name for the credential. To set the profile name, invoke the setProfileName() method of the CredentialInput class.

Note: If the profile is not set, then the default profile for the credential is used.

Disable Period

If your users want to go on a vacation or on long leave, then their credentials can be disabled only for that period, after which the credentials will be enabled automatically. This feature facilitates credential activation without the user making a request to User Administrator (UA) to do so.

The Issuance API enables you to set the disable period for the credential. To set the disable period, invoke the setDisableStartTime() and setDisableEndTime() methods of the CredentialInput class. The setDisableStartTime() and setDisableEndTime() methods use the ArcotDate.Type Class for setting the disable period.

ArcotDate.Type Class

The ArcotDate.Type class enables you to set the validity, disable start and end periods by using the following date formats: