PersonalAuthAPI - スコープ指定

PersonalAuthAPI には、個人認証情報のトークンのアクセス/更新を管理できるメソッドが用意されています。

この API にアクセスするには、個人認証 (com.snc.sn_ihub_personal_auth) プラグインを有効にする必要があります。この API は sn_cc 名前空間で実行されます。

この API にアクセスする前に、インスタンスで個人認証を構成する必要があります。詳細については、「Create a Connection & Credential alias」を参照してください。

PersonalAuthAPI - PersonalAuthAPI()

新しい PersonalAuthAPI オブジェクトをインスタンス化します。

表 : 1. パラメーター

名前	タイプ	説明
なし

次のコード例は、PersonalAuthAPI オブジェクトをインスタンス化する方法を示しています。

var personalAuthAPI = new sn_cc.PersonalAuthAPI();

PersonalAuthAPI - getInitiatorURL(文字列 aliasId)

指定されたエイリアスに関連付けられた個人認証情報の OAuth イニシエーター URL を返します。

表 : 2. パラメーター

名前	タイプ	説明
aliasId	文字列	OAuth イニシエーター URL を取得する接続エイリアスまたは認証情報エイリアスの Sys_id。 テーブル:接続および資格情報エイリアス [sys_alias]

表 : 3. 戻り値

タイプ	説明
文字列	指定されたエイリアスに関連付けられた個人認証情報の OAuth イニシエーター URL。指定されたエイリアスの個人認証情報が存在しない場合、メソッドは空の文字列を返します。

次のコード例は、このメソッドを呼び出す方法を示しています。

var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
var personalAuthAPI = new sn_cc.PersonalAuthAPI();
var result = personalAuthAPI.getInitiatorURL(aliasId);
gs.info(result);

出力:

/oauth_initiator.do?oauth_requestor_context=oauth_2_0_credentials&oauth_requestor=d84b5115532102104c4bddeeff7b12f2&oauth_provider_profile=d84b5115532102104c4bddeeff7b12ec&response_type=code&personal=true 

PersonalAuthAPI - isTokenValid(文字列 aliasId)

指定したエイリアスに関連付けられた個人認証情報に有効なアクセス/リフレッシュトークンが存在するかどうかを確認します。

表 : 4. パラメーター

名前	タイプ	説明
aliasId	文字列	関連する個人認証情報を確認するための接続エイリアスまたは認証情報エイリアスのSys_id。 テーブル:接続および資格情報エイリアス [sys_alias]

表 : 5. 戻り値

タイプ	説明
ブール	指定したエイリアス ID に関連付けられた個人認証情報があるかどうかを示すフラグ。 可能な値： true:有効な個人認証情報が存在します。 false:有効な個人認証情報が存在しません。

次のコード例は、このメソッドを呼び出す方法を示しています。

var aliasId = "e41b9dd1532102104c4bddeeff7b1250"; 
var personalAuthAPI = new sn_cc.PersonalAuthAPI();  
var result = personalAuthAPI.isTokenValid(aliasId); 
gs.info(result);

出力:

true

PersonalAuthAPI - revokeToken (文字列 aliasId)

指定されたエイリアスに関連付けられている個人認証情報の既存のアクセス/リフレッシュトークンを取り消します。

表 : 6. パラメーター

名前	タイプ	説明
aliasId	文字列	個人認証情報のアクセス/リフレッシュトークンを取り消す接続エイリアスまたは認証情報エイリアスのSys_id。 テーブル:接続および資格情報エイリアス [sys_alias]

表 : 7. 戻り値

タイプ

説明

オブジェクト

認証情報およびメソッド呼び出しのステータスに関する追加情報を取得するために呼び出すことができるメソッドを含むオブジェクト。これらのメソッドは、次にこのメソッドが呼び出されるまで使用できます。 <object_name>.getResponseStatus():revokeToken() メソッド呼び出しのステータス (成功または失敗) を返します。エラーに関する追加情報は、エラーログで確認できます。 <object_name>.getExpiryInSeconds(): 関連付けられた認証情報の有効期限が切れるまでの秒数を返します。この値がゼロ以外の場合、要求の取り消しは失敗しています。 <object_name>.isAuthenticated():個人認証トークンが存在するかどうかを示すブール値を返します。revokeToken() メソッドの呼び出しが成功した場合、このメソッドは false を返す必要があります。 <object_name>.getCredentialId():トークンに関連付けられた個人認証情報のsys_idを返します。OAuth 2.0 認証情報 [oauth_2_0_credentials] テーブルにあります。

次のコード例は、このメソッドを呼び出す方法を示しています。

var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
var personalAuthAPI = new sn_cc.PersonalAuthAPI();
var personalAuthResponse = personalAuthAPI.revokeToken(aliasId); 
gs.info(personalAuthResponse.getResponseStatus());
gs.info(personalAuthResponse.getExpiryInSeconds());
gs.info(personalAuthResponse.isAuthenticated());
gs.info(personalAuthResponse.getCredentialId());

出力:

SUCCESS
0
false
d84b5115532102104c4bddeeff7b12f2