1. OAA管理API
  2. タスク
  3. ポリシー・ルール

ポリシーのルールを取得する

get

/oaa-policy/policy/v1/{policygid}/rule/{ruleid}

リクエスト

パス・パラメータ

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

201レスポンス

ポリシー・ルール情報。
本文()
ルート・スキーマ: RuleResponse
型: object
これには、ポリシー・ルールに関連するリクエストされた操作に関する情報が含まれます。
ソースの表示
ネストされたスキーマ: schema
型: object
システム内のポリシー・ルールを定義します
ソースの表示
ネストされたスキーマ: conditionMap
型: array
UIルールを再構築するためのキー値のペアのマップ。OAAルールの必須要素は、entityRefId、操作、値(文字列の配列)、式、モード、isgroupです。
ソースの表示
  • ConditionMap
    ルールの再構築に使用されるキー/値のペアのマップ、またはルールに必要な追加パラメータをマップで渡すことができます
ネストされたスキーマ: conditions
型: array
ルールの実行時に評価される条件の配列。ルールに関連付けられたアクションを返すには、すべての条件がtrueである必要があります。
ソースの表示
  • Condition
    評価する条件。パラメータを指定しない場合、すべての条件がデフォルト値で評価されます。
ネストされたスキーマ: RuleAction
型: object
ルールがtrueと評価されたときに返されるアクション。
ソースの表示
ネストされたスキーマ: ConditionMap
型: object
ルールの再構築に使用されるキー/値のペアのマップ、またはルールに必要な追加パラメータをマップで渡すことができます
ソースの表示
ネストされたスキーマ: value
型: object
値は、jsonオブジェクトまたは単純な文字列になります。
ネストされたスキーマ: Condition
型: object
評価する条件。パラメータを指定しない場合、すべての条件がデフォルト値で評価されます。
ソースの表示
ネストされたスキーマ: parameters
型: array
すべてのオーバーライド・パラメータのリスト。
ソースの表示
ネストされたスキーマ: ConditionParameter
型: object
条件の評価時に必要な条件のパラメータ。
ソースの表示

401レスポンス

未認可

405レスポンス

無効な入力
本文()
ルート・スキーマ: RuleResponse
型: object
これには、ポリシー・ルールに関連するリクエストされた操作に関する情報が含まれます。
ソースの表示
ネストされたスキーマ: schema
型: object
システム内のポリシー・ルールを定義します
ソースの表示
ネストされたスキーマ: conditionMap
型: array
UIルールを再構築するためのキー値のペアのマップ。OAAルールの必須要素は、entityRefId、操作、値(文字列の配列)、式、モード、isgroupです。
ソースの表示
  • ConditionMap
    ルールの再構築に使用されるキー/値のペアのマップ、またはルールに必要な追加パラメータをマップで渡すことができます
ネストされたスキーマ: conditions
型: array
ルールの実行時に評価される条件の配列。ルールに関連付けられたアクションを返すには、すべての条件がtrueである必要があります。
ソースの表示
  • Condition
    評価する条件。パラメータを指定しない場合、すべての条件がデフォルト値で評価されます。
ネストされたスキーマ: RuleAction
型: object
ルールがtrueと評価されたときに返されるアクション。
ソースの表示
ネストされたスキーマ: ConditionMap
型: object
ルールの再構築に使用されるキー/値のペアのマップ、またはルールに必要な追加パラメータをマップで渡すことができます
ソースの表示
ネストされたスキーマ: value
型: object
値は、jsonオブジェクトまたは単純な文字列になります。
ネストされたスキーマ: Condition
型: object
評価する条件。パラメータを指定しない場合、すべての条件がデフォルト値で評価されます。
ソースの表示
ネストされたスキーマ: parameters
型: array
すべてのオーバーライド・パラメータのリスト。
ソースの表示
ネストされたスキーマ: ConditionParameter
型: object
条件の評価時に必要な条件のパラメータ。
ソースの表示

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可
先頭に戻る

例

次の例は、特定のポリシーのルールを取得するサンプルのリクエストとレスポンスを示します。

JSON形式で特定のポリシーのルールを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/policy/v1/141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171/rule/146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
    "status": "200",
    "message": "Rule information.",
    "rulegid": "146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a",
    "rule": {
        "name": "Factor and IP Rule",
        "rulegid": "146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a",
        "policygid": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171",
        "status": "ACTIVE",
        "note": "Factor and IP Rule",
        "conditions": [
            {
                "conditionKey": "always_on_user.condition0",
                "conditionId": "145_5f7d4a93ac1ad362c70a43a9b64351cf6789b3a0c55b425145c374aca7628bc1",
                "parameters": [
                    {
                        "paramname": "isTrue",
                        "value": "true"
                    }
                ]
            }
        ],
        "conditionMap": [
            {
                "key": "IpGroupCondition",
                "value": {
                    "mode": "BASIC",
                    "expression": "context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)",
                    "values": [
                        "113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b"
                    ],
                    "isgroup": true,
                    "attribute": "Context.IPAddress",
                    "operator": "In Group"
                }
            }
        ],
        "results": {
            "action": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718",
            "score": 300,
            "weight": 100
        }
    }
}

XML形式で特定のポリシーのルールを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/policy/v1/141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171/rule/146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <RuleResponse>
     <status>200</status>
     <message>Rule information.</message>
     <rulegid>146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a</rulegid>
     <rule>
         <name>Factor and IP Rule</name>
         <rulegid>146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a</rulegid>
         <policygid>141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171</policygid>
         <status>ACTIVE</status>
         <note>Factor and IP Rule</note>
         <conditions>
             <conditionKey>always_on_user.condition0</conditionKey>
             <conditionId>145_5f7d4a93ac1ad362c70a43a9b64351cf6789b3a0c55b425145c374aca7628bc1</conditionId>
             <parameters>
                 <paramname>isTrue</paramname>
                 <value>true</value>
             </parameters>
         </conditions>
         <conditionMap>
             <key>IpGroupCondition</key>
             <value>
                 <mode>BASIC</mode>
                 <expression>context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)</expression>
                 <values>113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b</values>
                 <isgroup>true</isgroup>
                 <attribute>Context.IPAddress</attribute>
                 <operator>In Group</operator>
             </value>
         </conditionMap>
         <results>
             <action>111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718</action>
             <score>300</score>
             <weight>100</weight>
         </results>
     </rule>
 </RuleResponse>
先頭に戻る