Oracle Access Governance REST APIs

機械翻訳について

キャンペーン詳細の取得

get

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

既存のキャンペーンの詳細を取得します。

リクエスト

パス・パラメータ

campaignId(required): string

一意のキャンペーン識別子。

ヘッダー・パラメータ

opc-request-id: string

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

トップに戻る

レスポンス

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

application/json

200レスポンス

キャンペーンの詳細。

ヘッダー

etag: string

オプティミスティックな同時実行性制御用。 `if-match`を参照してください。
opc-request-id: string

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

ルート・スキーマ : キャンペーン

型: object

AgcsCampaignのサマリー。

ソースを表示

approvalWorkflow: object InstanceWorkflow

承認プロセス・インスタンスのワークフロー。
completionRule: string

許容値: [ "APPROVE_ALL", "REVOKE_ALL" ]

レビュー失効時に適用する完了ルール。
creatorId: string

最小長: 1

最大長: 255

キャンペーン作成者のID。
criteria: array criteria

最大アイテム数: 20

キャンペーンの選択基準。
customReviewerId: string

最小長: 1

最大長: 255

カスタム・ユーザー・ワークフローのカスタム・レビューアのユーザーID。
customReviewerName: string

カスタム・ユーザー・ワークフロー内のカスタム・レビューアの表示名。
description: string

キャンペーンの説明。
displayName(必須): string

最小長: 1

最大長: 255

キャンペーン表示名。
frequency: string

許容値: [ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ]

繰返しキャンペーンの頻度。
id(必須): string

作成時に不変である一意のOracle ID (OCID)。
isRecurring: boolean

キャンペーンが繰り返されるかどうか - 繰返しの場合は、頻度およびseriesRecurrencesも指定されます。
justificationRule: string

許容値: [ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ]

キャンペーンの理由ルール。
messages: array messages

最大アイテム数: 50

メッセージのリスト。
ownerEmail: string

キャンペーン所有者Eメール。
ownerId: string

最小長: 1

最大長: 255

キャンペーン所有者ID。
ownerName: string

キャンペーン所有者名。
ownerUsername: string

キャンペーン所有者のユーザー名。
reviewLevels: array reviewLevels

最大アイテム数: 20

レビュー・レベル詳細のリスト。
reviewProgress: number(float)

レビューの進捗。
reviewWorkflowId: string

reviewLevelsに関連付けられたレビュー・ワークフローID。
scope: string

許容値: [ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ]

キャンペーンの範囲。
selectionReview: object SelectionReview

キャンペーンの選択数サマリー。
seriesRecurrences: string(x-obmcs-recurring-time)

最大長: 255

繰返しキャンペーンを実行するスケジュールを記述する繰返しルール。 RFC5545形式の文字列です。
status(必須): string

許容値: [ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ]

AgcsCampaignの現在の状態。
submissionType: string

許容値: [ "SAVE", "SUBMIT", "SUBMIT_NOW", "EWB_IDENTITY", "EWB_AC" ]

この処理の発行タイプ。
timeCreated(required): string(日時)

AgcsCampaignが作成された時間。 RFC3339形式の日時文字列
timeDue: string(date-time)

AgcsCampaignが作成された時間。 RFC3339形式の日時文字列
timeSeriesStarted: string(date-time)

繰返しキャンペーンのシリーズ開始日。 RFC3339形式の日時文字列
timeStarted: string(date-time)

AgcsCampaignが作成された時間。 RFC3339形式の日時文字列
type(必須): string

許容値: [ "ACCESS", "OWNERSHIP" ]

キャンペーンのタイプ(アクセスまたは所有権)。これは、CampaignCriteriaで読み取る内容(criteriaValueまたは条件)をUIで識別するのに役立ちます。

{
    "description":"Summary of the AgcsCampaign.",
    "type":"object",
    "required":[
        "id",
        "displayName",
        "status",
        "timeCreated",
        "type"
    ],
    "properties":{
        "id":{
            "description":"The Unique Oracle ID (OCID) that is immutable on creation.",
            "type":"string"
        },
        "displayName":{
            "description":"The campaign display name.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "type":{
            "description":"The type of the campaign (access or ownership). It will help UI to identify what to read in CampaignCriteria (criteriaValue or conditions).",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignType",
            "enum":[
                "ACCESS",
                "OWNERSHIP"
            ]
        },
        "ownerId":{
            "description":"The campaign owner ID.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "customReviewerId":{
            "description":"User ID of the custom reviewer in the custom user workflow.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "customReviewerName":{
            "description":"Display name of the custom reviewer in the custom user workflow.",
            "type":"string"
        },
        "ownerName":{
            "description":"The campaign owner name.",
            "type":"string"
        },
        "ownerUsername":{
            "description":"The username of campaign owner.",
            "type":"string"
        },
        "ownerEmail":{
            "description":"The campaign owner email.",
            "type":"string"
        },
        "creatorId":{
            "description":"The ID of the campaign creator.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "reviewProgress":{
            "description":"The progress of the review.",
            "type":"number",
            "format":"float"
        },
        "scope":{
            "description":"The scope of the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignScope",
            "enum":[
                "GOVERNANCE_SYSTEM",
                "CLOUD_PROVIDER",
                "AG"
            ]
        },
        "status":{
            "description":"The current state of the AgcsCampaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CampaignState",
            "enum":[
                "DRAFT",
                "SCHEDULED",
                "IN_PROGRESS",
                "READY_FOR_APPROVAL",
                "APPROVED",
                "TERMINATED",
                "SYSTEM_ABORTED"
            ]
        },
        "timeStarted":{
            "description":"The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeDue":{
            "description":"The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeCreated":{
            "description":"The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "criteria":{
            "description":"The selection criteria for the campaign.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CampaignCriteria"
            },
            "maxItems":20
        },
        "reviewWorkflowId":{
            "description":"The review workflow ID associated with the reviewLevels.",
            "type":"string"
        },
        "reviewLevels":{
            "description":"The list of review level details.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReviewLevelDetails"
            },
            "maxItems":20
        },
        "approvalWorkflow":{
            "$ref":"#/definitions/InstanceWorkflow"
        },
        "selectionReview":{
            "$ref":"#/definitions/SelectionReview"
        },
        "completionRule":{
            "description":"The completion rule to apply during review expiry.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CompletionType",
            "enum":[
                "APPROVE_ALL",
                "REVOKE_ALL"
            ]
        },
        "justificationRule":{
            "description":"The justification rule for the campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/JustificationType",
            "enum":[
                "REQUIRE_FOR_ALL",
                "REQUIRE_FOR_REVOKE",
                "OPTIONAL_FOR_ALL"
            ]
        },
        "description":{
            "description":"The description of the campaign.",
            "type":"string"
        },
        "isRecurring":{
            "description":"Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.",
            "type":"boolean"
        },
        "timeSeriesStarted":{
            "description":"The series start date of a recurring campaign. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "frequency":{
            "description":"The frequency of a recurring campaign.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/Frequency",
            "enum":[
                "ONE_TIME",
                "MONTHLY",
                "QUARTERLY",
                "HALF_YEARLY",
                "YEARLY"
            ]
        },
        "seriesRecurrences":{
            "description":"The recurrence rule which describes the schedule to run a recurring campaign. It is a RFC5545 formatted string.",
            "type":"string",
            "format":"x-obmcs-recurring-time",
            "maxLength":255
        },
        "messages":{
            "description":"The list of messages.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Message"
            },
            "maxItems":50
        },
        "submissionType":{
            "description":"Submission type of this action.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/SubmissionType",
            "enum":[
                "SAVE",
                "SUBMIT",
                "SUBMIT_NOW",
                "EWB_IDENTITY",
                "EWB_AC"
            ]
        }
    }
}

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

型: object

承認プロセス・インスタンスのワークフロー。

ソースを表示

displayName(必須): string

最小長: 1

最大長: 100

承認ワークフロー名。
stages(required): array stages

最小アイテム数: 1

最大アイテム数: 20

承認ワークフロー・ステージ。

{
    "description":"The workflow of an approval process instance.",
    "type":"object",
    "required":[
        "displayName",
        "stages"
    ],
    "properties":{
        "displayName":{
            "description":"The approval workflow name.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "stages":{
            "description":"The approval workflow stages.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstanceWorkflowStage"
            },
            "minItems":1,
            "maxItems":20
        }
    }
}

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

型: array

最大アイテム数: 20

キャンペーンの選択基準。

ソースを表示

Array of: object CampaignCriteria

基準フィルタ。

{
    "description":"The selection criteria for the campaign.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CampaignCriteria"
    },
    "maxItems":20
}

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

型: array

最大アイテム数: 50

メッセージのリスト。

ソースを表示

Array of: object Message

イベントに関する情報。

{
    "description":"The list of messages.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Message"
    },
    "maxItems":50
}

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

型: array

最大アイテム数: 20

レビュー・レベル詳細のリスト。

ソースを表示

Array of: object ReviewLevelDetails

レビュー・レベルの詳細。

{
    "description":"The list of review level details.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReviewLevelDetails"
    },
    "maxItems":20
}

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

型: object

キャンペーンの選択数サマリー。

ソースを表示

accessGuardrailTally(required): object Tally

tallyです。
approvalWorkflowTally(required): object Tally

tallyです。
entitlementTally(required): object Tally

tallyです。
identityCollectionTally(required): object Tally

tallyです。
identityTally(required): object Tally

tallyです。
policyTally(required): object Tally

tallyです。
resourceTally(required): object Tally

tallyです。
roleTally(required): object Tally

tallyです。
systemTally(required): object Tally

tallyです。

{
    "type":"object",
    "description":"The selection count summary for the campaign.",
    "required":[
        "identityTally",
        "entitlementTally",
        "resourceTally",
        "roleTally",
        "policyTally",
        "identityCollectionTally",
        "approvalWorkflowTally",
        "systemTally",
        "accessGuardrailTally"
    ],
    "properties":{
        "identityTally":{
            "$ref":"#/definitions/Tally"
        },
        "entitlementTally":{
            "$ref":"#/definitions/Tally"
        },
        "resourceTally":{
            "$ref":"#/definitions/Tally"
        },
        "roleTally":{
            "$ref":"#/definitions/Tally"
        },
        "policyTally":{
            "$ref":"#/definitions/Tally"
        },
        "identityCollectionTally":{
            "$ref":"#/definitions/Tally"
        },
        "approvalWorkflowTally":{
            "$ref":"#/definitions/Tally"
        },
        "systemTally":{
            "$ref":"#/definitions/Tally"
        },
        "accessGuardrailTally":{
            "$ref":"#/definitions/Tally"
        }
    }
}

ネストされたスキーマ : ステージ

型: array

最小アイテム数: 1

最大アイテム数: 20

承認ワークフロー・ステージ。

ソースを表示

Array of: object InstanceWorkflowStage

承認プロセス・インスタンス・ステージ。

{
    "description":"The approval workflow stages.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstanceWorkflowStage"
    },
    "minItems":1,
    "maxItems":20
}

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

型: object

承認プロセス・インスタンス・ステージ。

ソースを表示

approvers(required): array approvers

最小アイテム数: 1

最大アイテム数: 20

ステージの完了に必要な承認。
completedTasks: integer(int64)

完了したレビュー・タスク。
id(必須): string

ステージID。プロセス内で一意である必要があります。
operator(必須): string

デフォルト値: ALL

許容値: [ "ANY", "ALL" ]

承認プロセス・ステージの演算子。
state: string

許容値: [ "COMPLETED", "PENDING_APPROVAL" ]

承認ステージの現在の状態。 1つのステージのみが'PENDING_APPROVAL'状態になります。
totalTasks: integer(int64)

合計レビュー・タスク。

{
    "description":"The approval process instance stage.",
    "type":"object",
    "required":[
        "id",
        "operator",
        "approvers"
    ],
    "properties":{
        "id":{
            "description":"The stage id. Must be unique within the process.",
            "type":"string"
        },
        "operator":{
            "description":"The operator for the approval process stage.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessStageOperator",
            "enum":[
                "ANY",
                "ALL"
            ],
            "default":"ALL"
        },
        "approvers":{
            "description":"The approvals required for the stage to complete.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstanceWorkflowApprover"
            },
            "minItems":1,
            "maxItems":20
        },
        "state":{
            "description":"The current state of the approval stage.\nOnly one stage will be in 'PENDING_APPROVAL' state.\n",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/InstanceWorkflowStatus",
            "enum":[
                "COMPLETED",
                "PENDING_APPROVAL"
            ]
        },
        "totalTasks":{
            "description":"Total review tasks.",
            "type":"integer",
            "format":"int64"
        },
        "completedTasks":{
            "description":"Completed review tasks.",
            "type":"integer",
            "format":"int64"
        }
    }
}

ネストされたスキーマ : 承認者

型: array

最小アイテム数: 1

最大アイテム数: 20

ステージの完了に必要な承認。

ソースを表示

Array of: object InstanceWorkflowApprover

ステージ内で必要な承認。

{
    "description":"The approvals required for the stage to complete.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstanceWorkflowApprover"
    },
    "minItems":1,
    "maxItems":20
}

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

型: object

ステージ内で必要な承認。

ソースを表示

description(required): string

最小長: 1

最大長: 100

承認の説明。
id(必須): string

承認者ID。ステージ内で一意である必要があります。
isTemplateCompleted: boolean

現在のテンプレートが完了した場合。
pendingCount: integer(int64)

保留中のレビュー・タスク
state: string

許容値: [ "COMPLETED", "PENDING_APPROVAL" ]

ステージ内の承認タイプの承認リクエストの現在の状態。
templateDetails(required): object TemplateInstance

承認テンプレートのインスタンス。

{
    "type":"object",
    "description":"The approvals required within the stage.",
    "required":[
        "id",
        "templateDetails",
        "description"
    ],
    "properties":{
        "id":{
            "description":"The approver id. Must be unique within the stage.",
            "type":"string"
        },
        "templateDetails":{
            "$ref":"#/definitions/TemplateInstance"
        },
        "description":{
            "description":"A description of the approval.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "isTemplateCompleted":{
            "description":"If the current template is completed.",
            "type":"boolean"
        },
        "state":{
            "description":"The current state of the approval request for the approval type within the stage.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/InstanceWorkflowStatus",
            "enum":[
                "COMPLETED",
                "PENDING_APPROVAL"
            ]
        },
        "pendingCount":{
            "description":"Pending review tasks.",
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: object

承認テンプレートのインスタンス。

ソースを表示

id(必須): string

最小長: 1

最大長: 255

承認テンプレート名は一意である必要があります。
name: string

最小長: 1

最大長: 255

承認テンプレート名。
parameterValues: array parameterValues

承認テンプレート・パラメータ値のリスト。

{
    "type":"object",
    "description":"Instance of an approval template.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The approval template name, must be unique.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "name":{
            "description":"The approval template name.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "parameterValues":{
            "description":"List of approval template parameter values.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemplateParamTuple"
            }
        }
    }
}

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

型: array

承認テンプレート・パラメータ値のリスト。

ソースを表示

Array of: object TemplateParamTuple

IDで識別されるテンプレート・パラメータの値。

{
    "description":"List of approval template parameter values.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemplateParamTuple"
    }
}

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

型: object

IDで識別されるテンプレート・パラメータの値。

ソースを表示

description: string

最小長: 1

最大長: 255

テンプレート・パラメータIDの説明。
id(必須): string

最小長: 1

最大長: 255

テンプレート・パラメータID。テンプレート・パラメータ・リスト内で一意です。

{
    "type":"object",
    "description":"Value(s) for the template parameter identified by id.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"The template parameter id. Unique within the template parameter list.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "description":"Description of the template parameter id.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    }
}

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

型: object

基準フィルタ。

ソースを表示

conditions: array conditions

最大アイテム数: 100

フィルタ条件(これらの条件にはANDバインディングがあります)。
criteriaValue: array criteriaValue

最大アイテム数: 500

条件の値リスト。
type(必須): string

許容値: [ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL" ]

基準のタイプ。

{
    "type":"object",
    "description":"The criteria filter.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The type of the criteria.",
            "x-obmcs-top-level-enum":"#/definitions/CriteriaType",
            "enum":[
                "ORGANIZATION",
                "JOB_CODE",
                "IDENTITY_LOCATION",
                "RESOURCE",
                "RESOURCE_LOCATION",
                "ENTITLEMENT",
                "ROLE",
                "DOMAIN",
                "COMPARTMENT",
                "CLOUD_PROVIDER",
                "POLICY",
                "POLICY_CREATED",
                "CUSTOM_ATTRIBUTE",
                "CUSTOM_ATTRIBUTE_VALUE",
                "IDENTITY_COLLECTION",
                "IC_CREATED",
                "TARGET_IDENTITY",
                "TARGET",
                "GLOBAL_IDENTITY",
                "AM_WORKFLOW",
                "NOT_REVIEWED_SINCE",
                "ACCESS_GUARDRAIL"
            ]
        },
        "criteriaValue":{
            "type":"array",
            "description":"The list of values of the criteria.",
            "items":{
                "$ref":"#/definitions/CriteriaValue"
            },
            "maxItems":500
        },
        "conditions":{
            "description":"Filter condition (these conditions have an AND binding between them).",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Condition"
            },
            "maxItems":100
        }
    }
}

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

型: array

最大アイテム数: 100

フィルタ条件(これらの条件にはANDバインディングがあります)。

ソースを表示

Array of: object Condition

条件に関する情報。

{
    "description":"Filter condition (these conditions have an AND binding between them).",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Condition"
    },
    "maxItems":100
}

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

型: array

最大アイテム数: 500

条件の値リスト。

ソースを表示

Array of: object CriteriaValue

基準値。

{
    "type":"array",
    "description":"The list of values of the criteria.",
    "items":{
        "$ref":"#/definitions/CriteriaValue"
    },
    "maxItems":500
}

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

型: object

条件に関する情報。

ソースを表示

additionalAttributes: object additionalAttributes

許可される追加のプロパティ: additionalProperties

条件に関連する追加情報の追加属性。
basicCondition(required): object BasicCondition

条件に関する情報。
childConditions: object BasicConditionCollection

条件のコレクション。
type(必須): string

許容値: [ "IDENTITY_ATTRIBUTE", "PERMISSION", "DOES_NOT_HAVE_PERMISSION" ]

AGリソースのタイプ。

{
    "type":"object",
    "required":[
        "basicCondition",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The type for AG Resource.",
            "enum":[
                "IDENTITY_ATTRIBUTE",
                "PERMISSION",
                "DOES_NOT_HAVE_PERMISSION"
            ]
        },
        "basicCondition":{
            "$ref":"#/definitions/BasicCondition"
        },
        "childConditions":{
            "$ref":"#/definitions/BasicConditionCollection"
        },
        "additionalAttributes":{
            "type":"object",
            "description":"Additional attributes for additional information related to the condition.",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"The information about Condition."
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

string

{
    "type":"object",
    "description":"Additional attributes for additional information related to the condition.",
    "additionalProperties":{
        "type":"string"
    }
}

条件に関連する追加情報の追加属性。

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

型: object

条件に関する情報。

ソースを表示

dataType: string

許容値: [ "STRING", "NUMBER", "BOOLEAN", "DATE" ]

条件識別子のデータ型
displayName(必須): string

最小長: 1

最大長: 255

アクセス・ガードレール識別子
lhs(required): string

最小長: 1

最大長: 512

条件の左側。
operator(必須): string

許容値: [ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ]

アクセス・ガードレールの演算子。
rhs(required): array rhs

条件の右側。
rhsUiDetails: array rhsUiDetails

条件の右側の詳細。

{
    "type":"object",
    "required":[
        "displayName",
        "lhs",
        "operator",
        "rhs"
    ],
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Access Guardrails Identifier",
            "minLength":1,
            "maxLength":255
        },
        "operator":{
            "type":"string",
            "description":"The operator for a access guardrail.",
            "enum":[
                "EQ",
                "NE",
                "GT",
                "LT",
                "GTE",
                "LTE",
                "BEFORE",
                "AFTER",
                "TILL",
                "FROM",
                "BETWEEN",
                "NOT_BETWEEN",
                "IN",
                "NOT_IN",
                "CONTAINS",
                "NOT_CONTAINS",
                "BEGINS_WITH",
                "NOT_BEGINS_WITH",
                "ENDS_WITH",
                "NOT_ENDS_WITH",
                "IS_NULL",
                "IS_NOT_NULL",
                "EQUAL_WITH_NULL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ConditionOperator"
        },
        "lhs":{
            "type":"string",
            "description":"Left hand side of the condition.",
            "minLength":1,
            "maxLength":512
        },
        "rhs":{
            "type":"array",
            "description":"Right hand side of the condition.",
            "items":{
                "type":"string"
            }
        },
        "rhsUiDetails":{
            "type":"array",
            "description":"Right hand side details of the condition.",
            "items":{
                "$ref":"#/definitions/UiDetail"
            }
        },
        "dataType":{
            "type":"string",
            "description":"Data type for the condition Identifier",
            "enum":[
                "STRING",
                "NUMBER",
                "BOOLEAN",
                "DATE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/DataType"
        }
    },
    "description":"The information about Condition."
}

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

型: object

条件のコレクション。

ソースを表示

items(必須): array items

条件のリスト。

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of condition.",
            "items":{
                "$ref":"#/definitions/BasicCondition"
            }
        }
    },
    "description":"Collection of conditions."
}

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

型: array

条件の右側。

ソースを表示

Array of: string

{
    "type":"array",
    "description":"Right hand side of the condition.",
    "items":{
        "type":"string"
    }
}

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

型: array

条件の右側の詳細。

ソースを表示

Array of: object UiDetail

UIで値をレンダリングするためのUI詳細

{
    "type":"array",
    "description":"Right hand side details of the condition.",
    "items":{
        "$ref":"#/definitions/UiDetail"
    }
}

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

型: object

UIで値をレンダリングするためのUI詳細

ソースを表示

name(required): string

値の名前
value(required): string

値

{
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of value"
        },
        "value":{
            "type":"string",
            "description":"Value"
        }
    },
    "description":"Ui detail for rendering values on UI"
}

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

型: array

条件のリスト。

ソースを表示

Array of: object BasicCondition

条件に関する情報。

{
    "type":"array",
    "description":"List of condition.",
    "items":{
        "$ref":"#/definitions/BasicCondition"
    }
}

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

型: object

基準値。

ソースを表示

id: string

値のID。
name(required): string

値の名前。
subCriteria: array subCriteria

最大アイテム数: 500

キャンペーン基準の値リスト。

{
    "type":"object",
    "description":"The criteria value.",
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "description":"The ID of the value.",
            "type":"string"
        },
        "name":{
            "description":"The name of the value.",
            "type":"string"
        },
        "subCriteria":{
            "type":"array",
            "description":"The list of values of the Campaign criteria.",
            "items":{
                "$ref":"#/definitions/CampaignCriteria"
            },
            "maxItems":500
        }
    }
}

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

型: array

最大アイテム数: 500

キャンペーン基準の値リスト。

ソースを表示

Array of: object CampaignCriteria

基準フィルタ。

{
    "type":"array",
    "description":"The list of values of the Campaign criteria.",
    "items":{
        "$ref":"#/definitions/CampaignCriteria"
    },
    "maxItems":500
}

ネストされたスキーマ : メッセージ

型: object

イベントに関する情報。

ソースを表示

code: string

メッセージ・コード
dateCreated: string

メッセージが作成された時点のUNIXタイムスタンプ。
message: string

メッセージ

{
    "description":"Information about an event.",
    "type":"object",
    "properties":{
        "dateCreated":{
            "description":"The unix timestamp of when the message was created.",
            "type":"string"
        },
        "code":{
            "description":"The message code.",
            "type":"string"
        },
        "message":{
            "description":"The message.",
            "type":"string"
        }
    }
}

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

型: object

レビュー・レベルの詳細。

ソースを表示

durationDays: integer

最小値: 1

最大値: 30

レビュー・レベルの期間日数。
level(required): integer

このレビューのレベル。
notificationRecipient: string

許容値: [ "REVIEWER", "REVIEWER_AND_MANAGER" ]

最初の通知受信者。
reminderFrequencyDays: integer

最小値: 0

最大値: 29

リマインダ頻度(日数)。
reminderRecipient: string

許容値: [ "REVIEWER", "REVIEWER_AND_MANAGER" ]

リマインダ通知受信者。
reviewerAttributes: array reviewerAttributes

最大アイテム数: 20

レビューア属性のリスト(reviewerTypeがCUSTOM_OWNERまたはCLOUD_REVIEWERの場合のみ)。
reviewerType: string

許容値: [ "CUSTOM_OWNER", "OWNER", "USER", "USER_MANAGER", "CLOUD_REVIEWER", "APPROVAL_SYSTEM", "REQUESTOR", "BENEFICIARY", "BENEFICIARY_MANAGER", "CUSTOM_USER", "GROUP", "MANAGER_CHAIN", "SYSTEM", "NO_APPROVAL" ]

レベルのレビュー担当者タイプ。

{
    "type":"object",
    "description":"The details of a review level.",
    "required":[
        "level"
    ],
    "properties":{
        "level":{
            "description":"The level for this review.",
            "type":"integer"
        },
        "reviewerType":{
            "type":"string",
            "description":"The reviewer type for the level.",
            "x-obmcs-top-level-enum":"#/definitions/ReviewerType",
            "enum":[
                "CUSTOM_OWNER",
                "OWNER",
                "USER",
                "USER_MANAGER",
                "CLOUD_REVIEWER",
                "APPROVAL_SYSTEM",
                "REQUESTOR",
                "BENEFICIARY",
                "BENEFICIARY_MANAGER",
                "CUSTOM_USER",
                "GROUP",
                "MANAGER_CHAIN",
                "SYSTEM",
                "NO_APPROVAL"
            ]
        },
        "reviewerAttributes":{
            "description":"The list of reviewer attributes (only when reviewerType is CUSTOM_OWNER or CLOUD_REVIEWER).",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReviewerAttribute"
            },
            "maxItems":20
        },
        "durationDays":{
            "description":"The duration days for the review level.",
            "type":"integer",
            "minimum":1,
            "maximum":30
        },
        "notificationRecipient":{
            "description":"The first notification recipient.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/RecipientType",
            "enum":[
                "REVIEWER",
                "REVIEWER_AND_MANAGER"
            ]
        },
        "reminderRecipient":{
            "description":"The reminder notification recipient.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/RecipientType",
            "enum":[
                "REVIEWER",
                "REVIEWER_AND_MANAGER"
            ]
        },
        "reminderFrequencyDays":{
            "description":"the reminder frequency in days.",
            "type":"integer",
            "minimum":0,
            "maximum":29
        }
    }
}

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

型: array

最大アイテム数: 20

レビューア属性のリスト(reviewerTypeがCUSTOM_OWNERまたはCLOUD_REVIEWERの場合のみ)。

ソースを表示

Array of: object ReviewerAttribute

レビューアの属性。

{
    "description":"The list of reviewer attributes (only when reviewerType is CUSTOM_OWNER or CLOUD_REVIEWER).",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReviewerAttribute"
    },
    "maxItems":20
}

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

型: object

レビューアの属性。

ソースを表示

reviewerEmail: string

レビュー担当者のEメール。
reviewerId: string

レビューアのID。
reviewerIdType: string

許容値: [ "USER" ]

IDのタイプ。
reviewerName: string

レビューアの名前。
type(必須): string

許容値: [ "APPLICATION_OWNER", "ROLE_OWNER", "ENTITLEMENT_OWNER", "CLOUD_RESOURCE_OWNER" ]

レビューアのタイプ。

{
    "type":"object",
    "description":"The attributes of the reviewer.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"The type of reviewer.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ReviewerAttributeType",
            "enum":[
                "APPLICATION_OWNER",
                "ROLE_OWNER",
                "ENTITLEMENT_OWNER",
                "CLOUD_RESOURCE_OWNER"
            ]
        },
        "reviewerId":{
            "description":"The ID of the reviewer.",
            "type":"string"
        },
        "reviewerIdType":{
            "description":"The type of the ID.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ReviewerIdType",
            "enum":[
                "USER"
            ]
        },
        "reviewerName":{
            "description":"The name of the reviewer.",
            "type":"string"
        },
        "reviewerEmail":{
            "description":"The email of the reviewer.",
            "type":"string"
        }
    }
}

ネストされたスキーマ : 検数

型: object

tallyです。

ソースを表示

matchedCount(required): integer

基準に一致したアイテムの数。
totalCount(required): integer

アイテムの総数。

{
    "type":"object",
    "description":"the tally.",
    "required":[
        "matchedCount",
        "totalCount"
    ],
    "properties":{
        "matchedCount":{
            "description":"The count of items that matched the criteria.",
            "type":"integer"
        },
        "totalCount":{
            "description":"The total number of items.",
            "type":"integer"
        }
    }
}

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."
}

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."
}

トップに戻る

例

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

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

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

レスポンス本文の例

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

このJSONレスポンスは、「四半期アクセス監査 - Q2 2025」というタイトルのアクセス・レビュー・キャンペーンを表します。レビューでは、ユーザーに割り当てられた権限が評価されます。ビル・クラークはキャンペーンの所有者で、アーサー・ジョーンズは「管理ワークフロー階層」でのリクエストの承認を担当します。レビューが進行中で、指定されたユーザーの承認待ちがあります。

{
    "id": "ocid1.agcscampaign.oc1.iad.amaaaaaapzw5rdxxxxxxxe3f6obzlpjoze7tito4cpm6nwe2hpga5vtm56yq",
    "displayName": "Quarterly Access Audit - Q2 2025",
    "type": "ACCESS",
    "ownerId": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.55045.02xxxxbb4b201421b44aa046b3ceb16a",
    "customReviewerId": null,
    "customReviewerName": null,
    "ownerName": "Bill Clark",
    "ownerUsername": null,
    "ownerEmail": "Bill.Clark@example.com",
    "creatorId": "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.02xxxxbb4b201421b44aa046b3ceb16a",
    "reviewProgress": null,
    "scope": "AG",
    "status": "IN_PROGRESS",
    "timeStarted": "2025-06-02T06:52:25.684Z",
    "timeDue": "2025-06-07T06:52:25.684Z",
    "timeCreated": "2025-06-02T11:11:14.611Z",
    "criteria": [
        {
            "type": "ENTITLEMENT",
            "criteriaValue": [
                {
                    "id": "3xxxxx50-2c5b-436d-beca-dc4e225389d3",
                    "name": "BI-ReporterAdmin",
                    "subCriteria": null
                }
            ],
            "conditions": null
        }
    ],
    "reviewWorkflowId": "Guid_xxx6855b-f6b0-46a4-b808-a7c0016d601e",
    "approvalWorkflow": {
        "displayName": "Admin Workflow Hierarchy",
        "stages": [
            {
                "id": "10xx",
                "operator": "ALL",
                "approvers": [
                    {
                        "id": "AG_xxx",
                        "description": "Arthur Jones",
                        "state": "PENDING_APPROVAL",
                        "pendingCount": 1
                    }
                ],
                "state": "PENDING_APPROVAL",
                "totalTasks": 1,
                "completedTasks": 0
            }
        ]
    }
}

先頭に戻る