IsArcotIDAvailableEx()

This API checks whether the ArcotID PKI for the specified user is present. The ArcotID PKI is searched based on the AID_LOOKUP_MODE attribute. The following table explains how the input parameters (userNameOrAlias, appctx, orgname) are interpreted and used by the 3 lookup modes:
aa813test
This API checks whether the ArcotID PKI for the specified user is present. The ArcotID PKI is searched based on the AID_LOOKUP_MODE attribute. The following table explains how the input parameters (userNameOrAlias, appctx, orgname) are interpreted and used by the 3 lookup modes:
Lookup Mode
Input Parameter Interpretation
USERNAME_ONLY_MODE
The userNameOrAlias is treated as username and the appctx is ignored. The ArcotID PKI is searched based on username and orgname.
ALIAS_ONLY_MODE
All three parameters are used to search an ArcotID PKI and the userNameOrAlias is treated as alias. If no matching ArcotID PKI is found, then an error code is returned.
If orgname is NULL, then this parameter is ignored and the other two parameters are used to find a matching ArcotID PKI.
USERNAME_AND_ALIAS_MODE
The search is first based on USERNAME_ONLY_MODE, if the ArcotID PKI is not found then ALIAS_ONLY_MODE is used.
Syntax
isArcotIDAvailableEx(userNameOrAlias, appctx, orgname);
Parameters
Parameter
Type
Description
userNameorAliasID
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 to. For example, the user with a single ArcotID PKI can access different portals (savings account, insurance, and credit card) of a bank account.
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.
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 response = arcotClient.isArcotIDAvailableEx(userAlias, appctx, orgName);