CLI ルール メソッド

目次
casso127jpjp
目次
AccessType メソッド - ルールによって保護されたリソースへのアクセスを許可または拒否するフラグを設定または取得
AccessType メソッドは、ルールによって保護されたリソースへのアクセスを許可または拒否するフラグを設定または取得します。
構文
AccessType メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->AccessType([allowAccess])
[Parameters]
AccessType メソッドは以下のパラメータを受け入れます。
  1. allowAccess
    (int)
    (オプション)以下のように、ルールでリソースへのアクセスを許可するかどうかを指定します。
    • ルールでリソースへのアクセスを許可する場合は、1
    • ルールでリソースへのアクセスを拒否する場合は、0
戻り値
AccessType メソッドは以下のいずれかの値を返します。
  • ルールでリソースへのアクセスを許可する場合は、1
  • ルールでリソースへのアクセスを拒否する場合は、0
  • コールに失敗する場合は、-1
Action メソッド - ルールのアクションを設定または取得
Action メソッドは、ルールのアクションを設定または取得します。
構文
Action メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->Action([action])
[Parameters]
Action メソッドは以下のパラメータを受け入れます。
  1. action
    (文字列)
    (オプション)以下のように、実行するアクションを指定します。
    • アクション タイプが Web エージェント アクションの場合は、以下の 1 つ以上の HTTP アクションを使用します。複数のアクションを区切るには、カンマを使用します。
      • GET。HTTP を使用して表示するためのリソースを取得します。
      • POST。HTTP を使用してユーザ提供の情報を POST 送信します。
      • PUT。レガシー HTTP アクションをサポートします。
    • アクション タイプが認証イベントの場合
      • OnAuthAccept。ユーザ認証が正常に行われたときに発生します。
      • OnAuthAttempt。ユーザ名が入力されていないために、ユーザ認証が失敗したときに発生します。
      • OnAuthChallenge。カスタム認証方式で使用し、レスポンスを発行することができます。
      • OnAuthReject。ユーザが認証に失敗したときに発生します。
      • OnAuthUserNotFound。アクティブ レスポンスをトリガするために使用します。
    • アクション タイプが許可イベントの場合
      • OnAccessAccept。
        CA Single Sign-on
        で、リソースへのアクセスがユーザに対して正常に許可された場合に発生します。
      • OnAccessReject。
        CA Single Sign-on
        で、リソースへのアクセスが許可されなかったためにユーザを拒否する場合に発生します。
戻り値
Action メソッドは以下のいずれかの値を返します。
  • 新規または既存のルール アクション
  • コールに失敗した場合は、
    undef
ActiveExpr メソッド - ルールのアクティブな式を設定または取得
ActiveExpr メソッドは、ルールのアクティブな式を設定または取得します。
構文
ActiveExpr メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->ActiveExpr([expr])
[Parameters]
ActiveExpr メソッドは、以下のパラメータを受け入れます。
  1. expr
    (文字列)
    (オプション)実行するアクティブな式を指定します。
戻り値
ActiveExpr メソッドは以下のいずれかの値を返します。
  • 新規または既存のアクティブな式
  • コールに失敗した場合は、
    undef
Agent メソッド - グローバル ルールと関連付けられたエージェント オブジェクトまたはエージェント グループ オブジェクトを設定または取得
Agent メソッドは、グローバル ルールと関連付けられたエージェント オブジェクトまたはエージェント グループ オブジェクトを設定または取得します。
構文
Agent メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->Agent(agentObject)
[Parameters]
Agent メソッドは以下のパラメータを受け入れます。
  1. agentObject
    (
    objectType
    )
    ルールと関連付けるエージェント オブジェクトまたはエージェント グループ オブジェクトを指定します。objectType には PolicyMgtAgent または PolicyMgtGroup が有効です。
戻り値
Agent メソッドは新規または既存の PolicyMgtAgent オブジェクトか PolicyMgtGroup オブジェクトを返します。
注釈
ルールが作成された後、ルールと関連付けられたエージェントは、同じエージェント タイプ(Web エージェントなど)内でのみ変更できます。
注: ドメイン範囲があるルールは、レルムを介してエージェントと間接的に関連付けられます。
Description メソッド - ルールの説明を設定または取得
Description メソッドは、ルールの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->Description([ruleDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
  1. ruleDesc
    (文字列)
    (オプション)ルールの説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
  • 新規または既存のルールの説明
  • コールに失敗した場合は、空の文字列
IsEnabled メソッド - ルールを有効化または無効化
IsEnabled メソッドは、ルールを有効化または無効化します。
構文
IsEnabled メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->IsEnabled([enableFlag])
[Parameters]
IsEnabled メソッドは以下のパラメータを受け入れます。
  1. enableFlag
    (タイプ)
    (オプション)以下のようにルールを有効にするかどうかを指定します。
    • 1 はルールを有効にします。
    • 0 はルールを無効にします。
戻り値
IsEnabled メソッドは以下のいずれかの値を返します。
  • ルールが有効な場合は、1
  • ルールが無効な場合は、0
  • コールに失敗する場合は、-1
Name メソッド - ルール名を設定または取得
Name メソッドは、ルール名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->Name([ruleName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
  1. ruleName
    (文字列)
    ルールの名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
  • 新規または既存のルール名
  • コールに失敗した場合は、
    undef
RegexMatch メソッド - 正規表現パターン一致が有効かどうかを判定
RegexMatch メソッドは、リソース一致操作用の正規表現パターン一致が有効かどうかを判定するフラグを設定または取得します。
構文
RegexMatch メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->RegexMatch([enableFlag])
[Parameters]
RegexMatch メソッドは、以下のパラメータを受け入れます。
  1. enableFlag
    (int)
    (オプション)正規表現パターン一致を許可するかどうかを指定します。
    • 1 はパターン一致を許可します
    • 0 はパターン一致を許可しません
戻り値
RegexMatch メソッドは以下のいずれかの値を返します。
  • 正規表現パターン一致が有効な場合は、1
  • 正規表現パターン一致が無効な場合は、0
  • コールに失敗する場合は、-1
Resource メソッド - ルールによって保護されたリソースを設定または取得
Resource メソッドは、ルールによって保護されたリソースを設定または取得します。
構文
Resource メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRule->Resource()
[Parameters]
Resource メソッドは、パラメータを受け入れません。
戻り値
Resource メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、保護されたリソース
  • コールに失敗した場合は、
    undef