機械翻訳について

移動先

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

指定されたキャンペーンの概要レポートを取得

get

/access-governance/access-reviews/20250331/campaigns/{campaignId}/overviewReport

指定されたキャンペーンの概要レポートを取得します。

リクエスト

パス・パラメータ

• campaignId(required): string
  一意のキャンペーン識別子。

ヘッダー・パラメータ

• opc-request-id: string
  トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。

トップに戻る

レスポンス

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

• application/json

200レスポンス

指定されたキャンペーンの概要レポート。

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : OverviewReport

型: object

レビュー・タスク・ステータスの概要レポート。

ソースを表示

• assignmentTypeTotals(required): array assignmentTypeTotals
  各アサイメント・タイプに関連する合計。
• autoActionedCount: integer
  自動処理されたタスクの数。
• groupTotals(required): array groupTotals
  各グループ条件に関連する合計。
• timeGenerated(required): string(date-time)
  概要レポートが作成された日付。
• totalCount: integer
  すべてのアクセス・レビュー・タスクの合計数。

{
    "type":"object",
    "description":"The overview report of the review task status.",
    "required":[
        "timeGenerated",
        "assignmentTypeTotals",
        "groupTotals"
    ],
    "properties":{
        "timeGenerated":{
            "description":"The date that the overview report was generated.",
            "type":"string",
            "format":"date-time"
        },
        "assignmentTypeTotals":{
            "description":"The totals related to each assignment type.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AssignmentTypeTally"
            }
        },
        "groupTotals":{
            "description":"The totals related to each group criteria.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupTally"
            }
        },
        "autoActionedCount":{
            "description":"The count of tasks that were auto actioned.",
            "type":"integer"
        },
        "totalCount":{
            "description":"The total count of all access review tasks.",
            "type":"integer"
        }
    }
}

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

型: array

各アサイメント・タイプに関連する合計。

ソースを表示

• Array of: object AssignmentTypeTally
  割当タイプの検数。

{
    "description":"The totals related to each assignment type.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AssignmentTypeTally"
    }
}

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

型: array

各グループ条件に関連する合計。

ソースを表示

• Array of: object GroupTally
  グループの集計数。

{
    "description":"The totals related to each group criteria.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupTally"
    }
}

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

型: object

割当タイプの検数。

ソースを表示

• approvedCount(required): integer
  承認済レビューの件数。
• assignedCount: integer
  割当済レビューの件数。
• modifiedCount: integer
  変更されたレビューの件数。
• pendingCount(required): integer
  保留中のレビューの件数。
• removedCount: integer
  削除されたレビューの数。
• revokedCount(required): integer
  取り消されたレビューの数。
• type(必須): string
  許容値: [ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ]

  割当のタイプ。

{
    "type":"object",
    "description":"The tally counts of the assignment type.",
    "required":[
        "type",
        "pendingCount",
        "approvedCount",
        "revokedCount"
    ],
    "properties":{
        "type":{
            "description":"The type of the assignment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AssignmentType",
            "enum":[
                "ACCOUNT",
                "PERMISSION",
                "ROLE",
                "POLICY",
                "IC_STRUCTURAL",
                "UNMATCHED_ACCOUNT",
                "ORCH_SYSTEM",
                "AM_WORKFLOW",
                "ACCESS_GUARDRAIL"
            ]
        },
        "pendingCount":{
            "description":"The count of the pending reviews.",
            "type":"integer"
        },
        "approvedCount":{
            "description":"The count of the approved reviews.",
            "type":"integer"
        },
        "revokedCount":{
            "description":"The count of the revoked reviews.",
            "type":"integer"
        },
        "modifiedCount":{
            "description":"The count of the modified reviews.",
            "type":"integer"
        },
        "assignedCount":{
            "description":"The count of the assigned reviews.",
            "type":"integer"
        },
        "removedCount":{
            "description":"The count of the removed reviews.",
            "type":"integer"
        }
    }
}

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

型: object

グループの集計数。

ソースを表示

• topGroups(required): array topGroups
  このグループの上位5件の値のリスト。
• type(必須): string
  許容値: [ "ORGANIZATION", "RESOURCE", "ROLE", "CLOUD_ACCOUNT", "POLICY_CREATED_SINCE", "IC_CREATED_SINCE", "UA_TARGET", "UA_INSIGHTS", "AG_ORGANIZATION" ]

  グループのタイプ。

{
    "type":"object",
    "description":"The tally counts of the group.",
    "required":[
        "type",
        "topGroups"
    ],
    "properties":{
        "type":{
            "description":"The type of the group.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/GroupType",
            "enum":[
                "ORGANIZATION",
                "RESOURCE",
                "ROLE",
                "CLOUD_ACCOUNT",
                "POLICY_CREATED_SINCE",
                "IC_CREATED_SINCE",
                "UA_TARGET",
                "UA_INSIGHTS",
                "AG_ORGANIZATION"
            ]
        },
        "topGroups":{
            "description":"The list of the top 5 values in this group.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TopGroupTally"
            }
        }
    }
}

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

型: array

このグループの上位5件の値のリスト。

ソースを表示

• Array of: object TopGroupTally
  グループの最上位値の集計数

{
    "description":"The list of the top 5 values in this group.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TopGroupTally"
    }
}

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

型: object

グループの最上位値の集計数

ソースを表示

• name(required): string
  最上位グループ値の名前
• value(必須): integer
  グループのカウントまたは頻度

{
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the top group value"
        },
        "value":{
            "type":"integer",
            "description":"The count or frequency of the group"
        }
    },
    "description":"The tally counts of the top value in the group"
}

400レスポンス

不正なリクエスト

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401レスポンス

未認可

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404レスポンス

見つかりません

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

409レスポンス

競合

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429レスポンス

リクエストが多すぎます

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500レスポンス

内部サーバー・エラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

デフォルト・レスポンス

不明なエラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

トップに戻る

例

次の例は、キャンペーン・レポートを取得する方法を示しています。 サンプル・コマンドを実行する前に、プレースホルダー値を実際の値に置き換えます。

cURL例 - 問合せパラメータなし

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/access-reviews/${version}/campaigns/${campaignId}/overviewReport'

レスポンス本文の例

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

このレスポンスは、アカウント、権限、ロール、ワークフローなど、アクセス・レビュー・プロセスの様々な割当タイプのステータスの概要を示します。 アクセス変更を追跡するための待ち状態、承認済および取消済の棚卸の要約が表示されます。

{
    "timeGenerated": "2025-06-02T06:55:06.644Z",
    "assignmentTypeTotals": [
        {
            "type": "ACCOUNT",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "PERMISSION",
            "pendingCount": 1,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "ROLE",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "SYSTEM_ACCESS",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "WORKFLOW_APPROVAL",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        },
        {
            "type": "ACCESS_POLICY",
            "pendingCount": 0,
            "approvedCount": 0,
            "revokedCount": 0,
            "modifiedCount": 0
        }
    ],
    "groupTotals": [
        {
            "type": "RESOURCE",
            "topGroups": [
                {
                    "name": "Database Access Review - July",
                    "pendingCount": 1,
                    "approvedCount": 0,
                    "revokedCount": 0,
                    "modifiedCount": 0
                }
            ]
        },
        {
            "type": "DEPARTMENT",
            "topGroups": [
                {
                    "name": "Software Engineering Team",
                    "pendingCount": 1,
                    "approvedCount": 0,
                    "revokedCount": 0,
                    "modifiedCount": 0
                }
            ]
        },
        {
            "type": "ORGANIZATION",
            "topGroups": [
                {
                    "name": "IT Governance Committee",
                    "pendingCount": 1,
                    "approvedCount": 0,
                    "revokedCount": 0,
                    "modifiedCount": 0
                }
            ]
        }
    ]
}

先頭に戻る