ArcotID PKI Client Javascript APIs

CA ArcotID PKI Client Reference Guide › ArcotID PKI Client API Reference › ArcotID PKI Client Javascript APIs

ArcotID PKI Client Javascript APIs

The ArcotID PKI Client Javascript API controls all the client-side functions related to managing and authenticating ArcotID PKIs. These APIs are common for both ArcotID PKI Client browser plug-in and ArcotID PKI Client Applet. These include signing challenges and managing error messages. Before the API can be accessed by the client, the AuthMinder browser plug-in must be installed on the client system.

Methods	Description
AddCurrentCardToWallet()	Adds the current ArcotCard to the ArcotID PKI.
AttachCertToCurrentCard()	Attaches the new certificate to the ArcotCard.
CreateOfflineKeyBag()	Creates an offline key bag for the user and stores it in their ArcotID PKI.
GetErrorCode()	Returns an error code for the last unsuccessful call to the browser plug-in.
GetErrorMessage()	Returns a readable string that describes the last error encountered.
GetVersion()	Requests the version number of the currently loaded plug-in or applet.
GetVersionEx()	Gets the extended version information of the native client or the applet.
GetGlobalAttribute()	Requests a previously set plug-in attribute value.
SetAttribute()	Sets the value of predefined plug-in attributes and creates new plug-in attributes.
SignChallenge()	Signs a challenge previously obtained from the authentication server.
SignChallengeEx()	Signs a challenge previously obtained from the authentication server.
SetCurrentCardByIndex()	Sets the current card to be the one with the given index in the current wallet.
SetCurrentWalletFromEncoding()	Sets the current wallet to be the one that is passed in as a string parameter.
ImportArcotID()	Downloads the ArcotID PKI.
IsArcotIDAvailable()	Checks if the ArcotID PKI of the user is present on the system.
IsArcotIDAvailableEx()	Checks if the ArcotID PKI of the user is present based on the lookup mode.
RemoveArcotID()	Removes the ArcotID PKI.
RegisterCSPCertificates()	Registers the certificates with Microsoft CAPI.
SignChallengeNonBlocking()	Enables to support the ATM GUI applet on Mac OS X. The API call receives callback functions for success and error handling.
RefreshArcotIDs()	Instructs the ArcotID PKI client to re-read the storage areas for ArcotID PKIs.
SignChallengeEx2()	Signs a challenge based on the lookup mode.
RemoveArcotIDEx()	Deletes the ArcotID PKI of the user based on the lookup mode.
UpdateOfflineKeyBag()	Updates the offline key bag of the user.