ジャンプ先

• リクエスト
• レスポンス
• 例

ポリシー・ブラウザのポリシーを更新する

put

/policy/risk/v1/policies/{policygid}

ポリシー・ブラウザは、システムに作成された古いポリシーを確認することを希望する移行のお客様を対象としています。これらのポリシーの属性を更新する場合は、このAPIを使用できます。

リクエスト

パス・パラメータ

• policygid(required): string
  ポリシーの識別子。

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ : schema

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

先頭に戻る

レスポンス

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

• application/xml
• application/json

201レスポンス

ポリシーが更新されました

本文()

ルート・スキーマ: PolicyResponse

型: object

ソースの表示

• message: string
  リクエストのステータスに関連するメッセージ
• policy: object schema
  ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。
• policygid: string
  ポリシーの識別子。
• status: string
  リクエストのステータス

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy."
        },
        "policy":{
            "$ref":"#/components/schemas/Policy"
        }
    }
}

ネストされたスキーマ: schema

型: object

ポリシーを作成、変更およびフェッチするためのポリシー・オブジェクト。

ソースの表示

• agentgid(required): string
  ポリシーが属するエージェントの識別子
• assuranceLevelId(required): string
  ポリシーに関連付けられた保証レベルの識別子
• description(required): string
  ポリシーの説明。
• name(required): string
  ポリシー名。
• policygid: string
  ポリシーの識別子
• scoringEngine: string
  ポリシーのスコアリングに使用されるエンジン(集計済、平均、最大、最小、加重平均、加重最大、加重最小)
• status(required): string
  ポリシーのステータス。次のいずれかの値です。Active、DisabledまたはDeleted。
• weight: integer
  保証レベルに複数のポリシーがある場合、ポリシーの重みを定義する0から100までの数値。

{
    "type":"object",
    "required":[
        "agentgid",
        "assuranceLevelId",
        "name",
        "description",
        "status"
    ],
    "description":"Policy object for creating, modifying and fetching policy.",
    "properties":{
        "agentgid":{
            "type":"string",
            "description":"Identifier of the agent to which the policy belongs"
        },
        "assuranceLevelId":{
            "type":"string",
            "description":"Identifier of the assurance level which is associated with the policy"
        },
        "name":{
            "type":"string",
            "description":"Policy Name."
        },
        "description":{
            "type":"string",
            "description":"Policy description."
        },
        "status":{
            "type":"string",
            "description":"Status of the policy. It can be one of the following values. Active, Disabled or Deleted."
        },
        "scoringEngine":{
            "type":"string",
            "description":"Engine used for scoring the policy (Aggregated, Average, Maximum, Minimum, Weighted Average, Weighted Maximum, Weighted Minimum)"
        },
        "weight":{
            "type":"integer",
            "description":"Number between 0 to 100 to define the weight of the policy if there are multiple policies in the assurance level."
        },
        "policygid":{
            "type":"string",
            "description":"Identifier of the policy"
        }
    }
}

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

OARMでは、既存のポリシー(OAAMから移行)を更新できます。次に、リクエストおよびレスポンスの例を示します。OAAMポリシーは、OAAMポリシー・エクスプローラで表示できます。

JSON形式でOAAMポリシーを更新するcURLコマンド

curl --location --request PUT '<PolicyUrl>/policy/risk/v1/policies/51143_424de17591ff7cb74bba3759a9fa6aaf453769e756b08693b43253d09a113439' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "OAAM Challenge Policy 1",
    "description": "Device Identification policy for mobile devices.",
    "weight": "100",
    "scoringEngine": "Maximum"
}'

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

{
    "status": "200",
    "message": "Policy update is successfully.",
    "policygid": "51143_424de17591ff7cb74bba3759a9fa6aaf453769e756b08693b43253d09a113439",
    "policy": {
        "assuranceLevelId": "postauth",
        "name": "OAAM Challenge Policy 1",
        "description": "Device Identification policy for mobile devices.",
        "status": "ACTIVE",
        "scoringEngine": "Maximum",
        "weight": 100,
        "policygid": "51143_424de17591ff7cb74bba3759a9fa6aaf453769e756b08693b43253d09a113439"
    }
}

XML形式でOAAMポリシーを更新するcURLコマンド

curl --location --request PUT '<PolicyUrl>/policy/risk/v1/policies/51143_424de17591ff7cb74bba3759a9fa6aaf453769e756b08693b43253d09a113439' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--header 'Content-Type: application/json' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <Policy>
     <name>OAAM Challenge Policy 1</name>
     <description>Device Identification policy for mobile devices.</description>
     <weight>100</weight>
     <scoringEngine>Maximum</scoringEngine>
 </Policy>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <PolicyResponse>
     <status>200</status>
     <message>Policy update is successfully.</message>
     <policygid>51143_424de17591ff7cb74bba3759a9fa6aaf453769e756b08693b43253d09a113439</policygid>
     <policy>
         <assuranceLevelId>postauth</assuranceLevelId>
         <name>OAAM Challenge Policy 1</name>
         <description>Device Identification policy for mobile devices.</description>
         <status>ACTIVE</status>
         <scoringEngine>Maximum</scoringEngine>
         <weight>100</weight>
         <policygid>51143_424de17591ff7cb74bba3759a9fa6aaf453769e756b08693b43253d09a113439</policygid>
     </policy>
 </PolicyResponse>

先頭に戻る