Oracle Identity Governance Self ServiceのREST API

ポリシー違反タスクの取得

get

/iam/governance/selfservice/api/v1/policyviolations/{pvid}/causes

指定されたポリシー違反IDに関連付けられた原因を返します。返される属性は、fieldsという名前の問合せパラメータの一部として指定できます。例: 特定のポリシー違反のルール名、ルールの説明、ルールの条件およびステータス属性を取得するためのURIは、/policyviolations/{pvid}/causes?fields=ruleName,ruleDescription,ruleCondition,statusです。属性は、カンマ区切りリストで指定されます。原因は、ステータス、ルール名、ルールの説明などに基づいてフィルタできます。たとえば、"Invalid Email"という名前のルールに関連しているポリシー違反のすべての原因を取得するには、URIは/policyviolations/{pvid}/causes?q=ruleName eq Invalid::Emailとなります。ペイロードの一部として返されるステータスには、"ACTIVE,RESOLVED, MANUALLY FIXED etc"のような文字列が含まれていますが、フィルタに追加されるフィルタが存在する場合、ACTIVEに使用される文字列は、"policyviolationcause.status.active、policyviolationcause.status.resolved、policyviolationcause.status.manuallyfixed"などです

リクエスト

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

application/json

パス・パラメータ

pvid: string

ポリシー違反ID

問合せパラメータ

fields(optional): string

結果に返される属性。カンマ区切り属性を受け入れます。属性のサンプル値は、"action、comment、entityType、severity、status"です
policyDescription(optional): string

ポリシー違反のタスクはポリシーの説明に基づいてフィルタされます。指定された説明を含むポリシーに対応するすべてのタスクが返されます。
policyName(optional): string

ポリシー違反のタスクはポリシー名に基づいてフィルタされます。指定されたポリシー名を含むポリシーに対応するすべてのタスクが返されます。

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功

ヘッダー

ResponseTime: string

リクエストの処理にかかった時間(ミリ秒)を取得します。

ルート・スキーマ: PolicyViolationTasksGET

型: object

ソースを表示

count(optional): integer
hasMore(optional): boolean
links(optional): array links
policyViolationCauseList(optional): array policyViolationCauseList
totalResult(optional): integer

{
    "properties":{
        "totalResult":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "policyViolationCauseList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyViolationTaskGet"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

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

型: array

ソースを表示

[0]: object PolicyViolationTaskGet

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyViolationTaskGet"
    }
}

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

型: object

ソースを表示

href(optional): string
rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

fields(optional): array fields
id(optional): string
links(optional): array links
policyViolationId(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "policyViolationId":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

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

型: array

ソースを表示

[0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

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

型: object

ソースを表示

name(optional): string
value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

この例では、指定されたポリシー違反の原因を取得します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/5D4D3C107D7745A8BC21F6DB9888959D/causes

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/5D4D3C107D7745A8BC21F6DB9888959D/causes"
    }
  ],
  "totalResult": 1,
  "policyViolationCauseList": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/policyviolations/5D4D3C107D7745A8BC21F6DB9888959D/causes/287874BB86344E3DA243FC84029D76AF"
        }
      ],
      "policyViolationCauseId": "287874BB86344E3DA243FC84029D76AF",
      "policyViolationId": "5D4D3C107D7745A8BC21F6DB9888959D",
      "status": "ACTIVE"
    }
  ]
}

先頭に戻る