IsArcotIDAvailableEx()

CA Auth ID PKI クライアントリファレンスガイド › ArcotID PKI クライアント API リファレンス › ArcotID PKI クライアント Javascript API › IsArcotIDAvailableEx()

IsArcotIDAvailableEx()

この API は、指定されたユーザの ArcotID PKI が存在するかどうかを確認します。 ArcotID PKI は AID_LOOKUP_MODE 属性に基づいて検索されます。以下の表に、入力パラメータ（userNameOrAlias、appctx、orgname）が 3 つの検索モードによってどのように解釈および使用されるかについて説明します。

検索モード	入力パラメータの解釈
USERNAME_ONLY_MODE	userNameOrAlias はユーザ名として処理され、appctx は無視されます。 ArcotID PKI は username および orgname に基づいて検索されます。
ALIAS_ONLY_MODE	3 つのすべてのパラメータが ArcotID PKI を検索するために使用されます。また、userNameOrAlias はエイリアスとして処理されます。一致する ArcotID PKI が見つからない場合は、エラーコードが返されます。 orgname が NULL の場合、このパラメータは無視され、その他の 2 つのパラメータが一致する ArcotID PKI を検索するために使用されます。
USERNAME_AND_ALIAS_MODE	検索は、まず USERNAME_ONLY_MODE に基づいて行われ、ArcotID PKI が見つからない場合は ALIAS_ONLY_MODE が使用されます。

検索モード

入力パラメータの解釈

USERNAME_ONLY_MODE

userNameOrAlias はユーザ名として処理され、appctx は無視されます。 ArcotID PKI は username および orgname に基づいて検索されます。

ALIAS_ONLY_MODE

3 つのすべてのパラメータが ArcotID PKI を検索するために使用されます。また、userNameOrAlias はエイリアスとして処理されます。一致する ArcotID PKI が見つからない場合は、エラーコードが返されます。

orgname が NULL の場合、このパラメータは無視され、その他の 2 つのパラメータが一致する ArcotID PKI を検索するために使用されます。

USERNAME_AND_ALIAS_MODE

検索は、まず USERNAME_ONLY_MODE に基づいて行われ、ArcotID PKI が見つからない場合は ALIAS_ONLY_MODE が使用されます。

構文

isArcotIDAvailableEx(userNameOrAlias, appctx, orgname);

パラメータ

パラメータ	Type	説明
userNameorAliasID	文字列	Arcot カードと関連付けられた一意のユーザ識別子であるユーザ名およびエイリアス。注：エイリアスはユーザから取得され、指定されたアプリケーションコンテキストを持つ属性として ArcotID PKI に格納されます。
appctx	文字列	ユーザがログインするアプリケーションコンテキストの名前。たとえば、単一の ArcotID PKI を持ったユーザは、銀行口座の各種ポータル（預金口座、保険、およびクレジットカード）にアクセスできます。アプリケーションコンテキストは、ArcotID PKI の発行時に ArcotID 発行アプリケーションによって提供されます。
orgName	文字列	ユーザが属する AuthMinder 組織の名前。

Type

説明

userNameorAliasID

文字列

Arcot カードと関連付けられた一意のユーザ識別子であるユーザ名およびエイリアス。

注：エイリアスはユーザから取得され、指定されたアプリケーションコンテキストを持つ属性として ArcotID PKI に格納されます。

appctx

文字列

ユーザがログインするアプリケーションコンテキストの名前。たとえば、単一の ArcotID PKI を持ったユーザは、銀行口座の各種ポータル（預金口座、保険、およびクレジットカード）にアクセスできます。

アプリケーションコンテキストは、ArcotID PKI の発行時に ArcotID 発行アプリケーションによって提供されます。

orgName

文字列

ユーザが属する AuthMinder 組織の名前。

戻り値

メソッドが成功した場合は、TRUE が返されます。メソッドが失敗した場合は、FALSE が返されます。

例

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

var userAlias" = "jdoe-sb";

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