CLI ポリシー管理レスポンス メソッド
ここでは、CLI レスポンス メソッドについて説明します。
casso127jpjp
ここでは、CLI レスポンス メソッドについて説明します。
CreateAttribute メソッド - レスポンスのスタティック レスポンス属性を作成
CreateAttribute メソッドは、レスポンスのスタティック レスポンス属性を作成します。
構文
CreateAttribute メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtResponse->CreateAttribute(attrName, varValue [, TTL])
[Parameters]
CreateAttribute メソッドは、以下のパラメータを受け入れます。
- attrName(文字列)作成する属性の名前を指定します。有効な属性名はレスポンスと関連付けられたエージェントのタイプに応じて変わります。エージェント タイプは、レスポンスの作成時に表示される[CA Single Sign-onレスポンス]ダイアログで指定されます。特定のエージェント タイプと関連付けられた属性のリストを確認するには、[CA Single Sign-onレスポンス]ダイアログでエージェント タイプを選択し、[作成]をクリックします。その後に、CA Single Sign-onレスポンス属性エディタの[属性]フィールドで選択肢を表示します。たとえば、CA Single Sign-onWeb エージェント タイプでレスポンスを作成する場合は、以下のいずれかのレスポンス属性を作成できます。
- WebAgent-HTTP-Header-Variable
- WebAgent-HTTP-Cookie-Variable
- WebAgent-OnAccept-Redirect
- WebAgent-OnAccept-Text
- WebAgent-OnAuthAccept-Session-Idle-Timeout
- WebAgent-OnAuthAccept-Session-Max-Timeout
- WebAgent-OnReject-Redirect
- WebAgent-OnReject-Text
- varValue(文字列)スタティック属性の値を指定します。この値は[CA Single Sign-onレスポンス]ダイアログの[値]列に表示されます。値は変数か Cookie 値または名前/値ペアを表します。値と共に名前も指定する必要がある場合は、フォーム名 = 値を使用します。たとえば、属性 WebAgent-HTTP-Header-Variable には名前と値のペアが必要です。名前が show_content で、値がはいの場合は、varValue に show_content=yes を割り当てます。
- TTL(int)(オプション)レスポンス属性の値が再計算されるまでに経過できる秒単位の時間量を指定します。
戻り値
CreateAttribute メソッドは以下のいずれかの値を返します。
- PolicyMgtResponseAttr オブジェクト
- コールに失敗した場合は、undef
注釈
コマンド ライン インターフェースでは、レスポンス属性としてユーザ属性または DN 属性を作成できません。
PolicyMgtResponse>CreateActiveAttribute メソッドと PolicyMgtResponse>CreateVariableAttribute メソッドの説明も参照してください。
DeleteAttribute メソッド - レスポンス内のレスポンス属性を削除
DeleteAttribute メソッドは、レスポンス内のレスポンス属性を削除します。
構文
DeleteAttribute メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtResponse->DeleteAttribute(respAttr)
[Parameters]
DeleteAttribute メソッドは以下のパラメータを受け入れます。
- respAttr(PolicyMgtResponseAttr)削除するレスポンス属性を指定します。
戻り値
DeleteAttribute メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗する場合は、-1
Description メソッド - レスポンスの説明を設定または取得
Description メソッドは、レスポンスの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtResponse->Description([resDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- resDesc(文字列)(オプション)レスポンスの説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- 新規または既存のレスポンスの説明
- コールに失敗した場合は、空の文字列
GetAllAttributes メソッド - 設定されたレスポンス属性のリストを取得
GetAllAttributes メソッドは、設定されたレスポンス属性のリストを取得します。
構文
GetAllAttributes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtResponse->GetAllAttributes() (returnCode)
[Parameters]
GetAllAttributes メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAttributes メソッドは以下の値を返します。
- PolicyMgtResponseAttr オブジェクトの配列
Name メソッド - レスポンス名を設定または取得
Name メソッドは、レスポンス名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtResponse->Name([resName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- resName(文字列)(オプション)レスポンス名を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存のレスポンス名
- コールに失敗した場合は、undef