ジャンプ先

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

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

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

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: array

ソースを表示

• 配列: オブジェクト 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

ソースを表示

• 配列: オブジェクト Fields

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

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

型: array

ソースを表示

• 配列: オブジェクト 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/D15E3910F42A4626AA8CBA219A
58A478/causes

レスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes?offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes?offset=1&limit=10"
        }
    ],
    "count": 2,
    "hasMore": false,
    "totalResult": -1,
    "policyViolationCauseList": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes/7DBE8AB5D3D1493CB6022351E37A8492"
                }
            ],
            "id": "7DBE8AB5D3D1493CB6022351E37A8492",
            "policyViolationId": "D15E3910F42A4626AA8CBA219A58A478",
            "fields": [
                {
                    "name": "ruleCondition",
                    "value": {
                        "substituteArg2": false,
                        "secondArgument": "Fraud Supervisor",
                        "searchBase": null,
                        "searchDepth": null,
                        "firstArgument": "role",
                        "operator": "EQUAL"
                    }
                },
                {
                    "name": "update",
                    "value": "2019-04-10T21:12:16Z"
                },
                {
                    "name": "policyViolationId",
                    "value": "D15E3910F42A4626AA8CBA219A58A478"
                },
                {
                    "name": "updateById",
                    "value": "4"
                },
                {
                    "name": "name",
                    "value": "0F9889703C404D3F909192391A9B1C38"
                },
                {
                    "name": "remediationEntityId",
                    "value": "9"
                },
                {
                    "name": "create",
                    "value": "2019-04-10T21:12:16Z"
                },
                {
                    "name": "action",
                    "value": "ACTIVATE"
                },
                {
                    "name": "ruleName",
                    "value": "rule1 fraud supervisor"
                },
                {
                    "name": "createById",
                    "value": "4"
                },
                {
                    "name": "remediationEntityType",
                    "value": "Role"
                },
                {
                    "name": "id",
                    "value": "7DBE8AB5D3D1493CB6022351E37A8492"
                },
                {
                    "name": "ruleId",
                    "value": "AB4F6F3D8A7D428EA054B11D96EC726D"
                },
                {
                    "name": "status",
                    "value": "ACTIVE"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policyviolations/D15E3910
F42A4626AA8CBA219A58A478/causes/E07FC16C459147A49A7BDADF1810EE92"
                }
            ],
            "id": "E07FC16C459147A49A7BDADF1810EE92",
            "policyViolationId": "D15E3910F42A4626AA8CBA219A58A478",
            "fields": [
                {
                    "name": "ruleCondition",
                    "value": {
                        "substituteArg2": false,
                        "secondArgument": "Fraud Supervisor",
                        "searchBase": null,
                        "searchDepth": null,
                        "firstArgument": "role",
                        "operator": "EQUAL"
                    }
                },
                {
                    "name": "update",
                    "value": "2019-04-10T21:12:16Z"
                },
                {
                    "name": "policyViolationId",
                    "value": "D15E3910F42A4626AA8CBA219A58A478"
                },
                {
                    "name": "updateById",
                    "value": "4"
                },
                {
                    "name": "name",
                    "value": "760680CEE791466E9E85175E433143CF"
                },
                {
                    "name": "create",
                    "value": "2019-04-10T21:12:16Z"
                },
                {
                    "name": "action",
                    "value": "ACTIVATE"
                },
                {
                    "name": "ruleName",
                    "value": "rule1 fraud supervisor"
                },
                {
                    "name": "createById",
                    "value": "4"
                },
                {
                    "name": "id",
                    "value": "E07FC16C459147A49A7BDADF1810EE92"
                },
                {
                    "name": "ruleId",
                    "value": "AB4F6F3D8A7D428EA054B11D96EC726D"
                },
                {
                    "name": "status",
                    "value": "ACTIVE"
                }
            ]
        }
    ]
}

先頭に戻る