CA Auth ID OTP Developer's Guide › CA Auth ID OTP APIs

CA Auth ID OTP APIs

This chapter discusses the CA Auth ID OTP Software Development Kit (SDK). The most common tasks performed using this SDK are provisioning the CA Auth ID OTP account to the user’s device and generating passcodes. Other tasks are outlined in the following list:

The chapter introduces you to the interfaces and classes that you will be using for different tasks and later explains the usage in detail.

• Provisioning (Downloading) CA Auth ID OTP Accounts

  To perform CA Auth ID OTP authentication, you need to first create an account for the user that contains the CA Auth ID OTP information and save it on their device. The Provisioning CA Auth ID OTP Accounts section discusses the provisionAccount() method in the API class that you use to create CA Auth ID OTP accounts.

• Generating Passcodes

  To perform CA Auth ID OTP authentication, the users have to first generate a passcode for authentication. The Generating Passcodes section discusses the generateOTP() method in the API class that you use to generate passcodes.

• Resetting CA Auth ID OTP PIN

  The Resetting CA Auth ID OTP PIN section discusses the resetPin() method in OTP class that you use to change the user’s CA Auth ID OTP PIN.

• Managing Accounts

  The Managing Accounts section discusses the methods of the API class that you use to read and delete CA Auth ID OTP accounts stored in the default location.

  If you choose to store the accounts in a custom location, you must implement the Store interface. Refer to the Choosing Custom Storage Medium section. To store the accounts in memory, use MemoryStore class. Refer to the Storing Accounts in Memory section.

• Device Locking

  Depending on the device that is used, the CA Auth ID OTP library supports default parameters for locking the account to the device. To lock an account, implement the DeviceLock interface, as discussed in the Device Locking section.

• Reading CA Auth ID OTP Details

  The Reading CA Auth ID OTP Account Details section discusses the API class fields that hold the CA Auth ID OTP details such as, unique identifier for the account, timestamp when the account was used, number of times the account was used, and friendly name for the account. It also discusses the classes that are used to set and get additional CA Auth ID OTP attributes.

• Checking CA Auth ID OTP SDK Version

  The Checking Library Version section discusses the getVersion() method in OTP class that is used to check the version of CA Auth ID OTP SDK.