シングル サインオン トークン メソッド
目次
casso1283
目次
Decode メソッド -- シングル サインオン トークンをデコード
Decode メソッドはシングル サインオン トークンをデコードし、その属性のサブセットを返します。さらに、ゼロ以外の値をこのメソッドに渡して、トークンの最後にアクセスされたタイムスタンプを更新するオプションがあります。更新されたトークンを文字列形式で取得するには、SSOToken->GetString をコールして、トークン文字列を SMSESSION Cookie に書き込みます。
構文
Decode メソッドの形式は以下のとおりです。
Netegrity::SSOToken->Decode([update])
[Parameters]
Decode メソッドは以下のパラメータを受け入れます。
- update(int)(オプション)以下のように更新されたトークンが要求されるかどうかを指定します。
- 値 = ゼロ以外更新されたトークンが要求されることを指定します。
- 値 = 0(デフォルト)更新されたトークンが要求されないことを指定します。
戻り値
Decode メソッドは以下のいずれかの値を返します。
- 以下のサブセットが含まれる属性の配列
- ATTR_CLIENTIPユーザが保護されているリソースの要求を開始したマシンの IP アドレスを指定します。
- ATTR_DEVICENAMEトークンをデコードするエージェントの名前を指定します。
- ATTR_IDLESESSIONTIMEOUTセッションの最大アイドル時間を指定します。
- ATTR_LASTSESSIONTIMEポリシー サーバがセッション内で最後にアクセスされた時間を指定します。
- ATTR_MAXSESSIONTIMEOUTセッションをアクティブにできる最大時間を指定します。
- ATTR_SESSIONIDログイン コールから返されるセッション ID を指定します。
- ATTR_SESSIONSPECログイン コールから返されるセッション指定情報を指定します。
- ATTR_STARTSESSIONTIMEログインに成功した後にセッションがいつ開始されたかを指定します。
- ATTR_USERDNユーザの識別名を指定します。
- ATTR_USERNAMEユーザの名前を指定します。
- undefメソッドが失敗したことを指定します。
注釈
シングル サインオン オブジェクトを作成するには、AgentUser->CreateSSOToken をコールします。
GetString メソッド -- SSO トークン オブジェクトの文字列表現を取得
GetString メソッドは、シングル サインオン トークン オブジェクトの文字列表現を取得します。GetString のコール後に、SMSESSION Cookie にトークン文字列を書き込むことができます。
構文
GetString メソッドの形式は以下のとおりです。
Netegrity::SSOToken->GetString()
[Parameters]
GetString メソッドは、パラメータを受け入れません。
戻り値
GetString メソッドは、以下の値を返します。
- SSO_token (文字列)
注釈
GetString は、CreateSSOToken でシングル サインオン トークン オブジェクトを作成した後にコールできます。Decode で最後にアクセスされたトークンのタイム スタンプを更新した後に GetString をコールすることもできます。
GetVersion メソッド -- SSO トークンの
SiteMinder
バージョンを取得GetVersion メソッドは、シングル サインオン トークンの
SiteMinder
バージョンを取得します。構文
GetVersion メソッドの形式は以下のとおりです。
Netegrity::SSOToken->GetVersion()
[Parameters]
GetVersion メソッドは、パラメータを受け入れません。
戻り値
GetVersion メソッドは、以下の値を返します。
- version (int)シングル サインオン トークンのSiteMinderバージョンを指定します。
IsThirdParty メソッド -- トークンがカスタムかどうかを判定
IsThirdParty メソッドは、トークンが元はカスタム(またはサードパーティ)エージェントによって作成され、まだ標準の
SiteMinder
エージェントによって更新されていないかどうかを判定します。構文
IsThirdParty メソッドの形式は以下のとおりです。
Netegrity::SSOToken->IsThirdParty()
[Parameters]
IsThirdParty メソッドは、パラメータを受け入れません。
戻り値
IsThirdParty メソッドは以下のいずれかの整数値を返します。
- 値 = ゼロ以外トークンが元はカスタム エージェントによって作成され、まだ標準のSiteMinderエージェントによって更新されていないことを指定します。
- 値 = 0トークンがカスタム エージェントによって作成されていないか、標準のSiteMinderエージェントによって更新されていることを指定します。