RemoveArcotIDEx()

CA ArcotID PKI Client Reference Guide › ArcotID PKI Client API Reference › ArcotID PKI Client Javascript APIs › RemoveArcotIDEx()

RemoveArcotIDEx()

This API selects an ArcotID PKI from a list of ArcotID PKIs available to it, based on the input parameters (userNameOrAlias, appctxName, orgName) and deletes it. ArcotID PKI selection is based on the lookup mode that is set, see the IsArcotIDAvailableEx() section. After the ArcotID PKI is deleted it is not available for authentication.

Syntax

RemoveArcotIDEx(userNameOrAlias, appctx, orgname, storageType)

Parameters

Parameter	Type	Description
userNameorAlias	string	User name and the alias, which are the unique user identifier associated with the Arcot card. Note: The alias is obtained from the user and stored in the ArcotID PKI as an attribute with the specified application context.
appctx	string	The name of the application context to which the user is logging in. Application context is supplied by the ArcotID Issuance application during ArcotID PKI issuance.
orgName	string	The name of the AuthMinder organization to which the user belongs.
storageType	string	Specifies the medium, where the ArcotID PKI is stored. See "StorageType" for more information.

Returns

If the method is successful, then it returns TRUE. If the method is unsuccessful, then it returns FALSE.

Example

var arcotClient = new ArcotClient();
var orgName = "safebank";
var appctx = "safebank-online";

var userAlias" = "jdoe-sb";

var storageType="hd";

var response = arcotClient.RemoveArcotIDEx(userAlias, appctx, orgName, storageType);