機械翻訳について

移動先

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

ポリシーのリストの取得

get

/access-governance/access-controls/20250331/policies

ページ区切りをサポートしている使用可能なすべてのポリシーの詳細を返します。

リクエスト

問合せパラメータ

• keywordContains: string
  フィルタするキーワード。 指定できるキーワードは1つのみです。 デフォルトは空の文字列です。
• limit: integer
  最小値: 1

  最大値: 1000

  返されるアイテムの最大数。

  デフォルト値: 10
• page: string
  最小長: 1

  結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
• sortBy: string
  ソートの基準となるフィールド。 指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。

  デフォルト値: timeCreated

  許容値: [ "timeCreated", "displayName" ]
• sortOrder: string
  使用するソート順(ASCまたはDESC)。

  許容値: [ "ASC", "DESC" ]
• status: string
  指定されたステータスのエンティティの検索に使用するフィルタ。

  デフォルト値: ALL

  許容値: [ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ]

ヘッダー・パラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

ポリシー・サマリーのリスト

ヘッダー

• opc-next-page: string
  アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : PolicyCollection

型: object

PolicyCollectionには、ポリシーに関する要約情報が含まれます。

ソースを表示

• items(必須): array items
  ポリシーに関する要約情報を含むリスト。

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List containing summarized information about Policies.",
            "items":{
                "$ref":"#/definitions/PolicySummary"
            }
        }
    },
    "description":"PolicyCollection contains summarized information about Policies."
}

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

型: array

ポリシーに関する要約情報を含むリスト。

ソースを表示

• Array of: object PolicySummary
  保険契約要約

{
    "type":"array",
    "description":"List containing summarized information about Policies.",
    "items":{
        "$ref":"#/definitions/PolicySummary"
    }
}

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

型: object

保険契約要約

ソースを表示

• createdBy: object IdInfo
  汎用識別情報オブジェクト。
• customAttributes: object customAttributes
  アクセス・バンドルに関連付けられたメタデータ
• description: string
  保険契約の摘要。
• id(必須): string
  作成時に不変である一意のOracle ID (OCID)。
• isOwner: boolean
  ログイン・ユーザーがこのリソースの所有者であるかどうかをチェックするブール値。
• name: string
  わかりやすい名前。 ユニークでなければなりません。 機密情報の入力は避けてください。
• primaryOwner: object PrimaryOwner
  プライマリ所有者の詳細。
• status: string
  許容値: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]

  ポリシーのステータス
• tags: array tags
  ポリシーに添付されたタグのリスト。
• timeCreated: string(date-time)
  ポリシーが作成された時間。 「An RFC3339」書式設定日時文字列
• timeUpdated: string(date-time)
  ポリシーが最後に更新された時間。 「An RFC3339」書式設定日時文字列

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name. Have to be unique. Avoid entering confidential information."
        },
        "description":{
            "type":"string",
            "description":"Description of the Policy."
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Policy was created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Policy was last updated. An RFC3339 formatted datetime string"
        },
        "status":{
            "type":"string",
            "description":"Status of the Policy",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Policy.",
            "items":{
                "type":"string"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the access bundle",
            "properties":{
            }
        },
        "primaryOwner":{
            "$ref":"#/definitions/PrimaryOwner"
        },
        "isOwner":{
            "type":"boolean",
            "description":"Boolean value checking if logged-in user is owner of this resource or not."
        }
    },
    "description":"Policy Summary."
}

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

型: object

汎用識別情報オブジェクト。

ソースを表示

• displayName: string
  エンティティの表示名。
• id: string
  エンティティのID。
• name: string
  エンティティの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic identifying information object."
}

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

型: object

アクセス・バンドルに関連付けられたメタデータ

ソースを表示

{
    "type":"object",
    "description":"Metadata associated with the access bundle",
    "properties":{
    }
}

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

型: object

プライマリ所有者の詳細。

ソースを表示

• displayName: string
  プライマリ所有者の表示名。
• value: string
  プライマリ所有者のID。

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Id of the primary Owner."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the primary Owner."
        }
    },
    "description":"Details of a primary Owner."
}

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

型: array

ポリシーに添付されたタグのリスト。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Policy.",
    "items":{
        "type":"string"
    }
}

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

トップに戻る

例

次の例は、GETリクエストを発行してポリシーのリストを取得する方法を示しています。

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

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://${service-instance-url}/access-governance/access-controls/20250331/policies'

レスポンス本文の例

次の例は、使用可能なすべてのロールのリストを含む、JSON形式のレスポンス本文の内容を示しています:

{
    "items": [
        {
            "id": "958b9x2a-0993-4x16-8ff2-d4730307c1c0",
            "name": "Database Administration Policy",
            "description": "Defines administrative privileges for database management, including configuration settings, user management, and system maintenance.",
            "createdBy": {
                "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                "name": "Amel MacLead",
                "displayName": "Amel MacLead"
            },
            "timeCreated": "2025-04-10T20:58:00.273Z",
            "timeUpdated": "2025-04-10T20:58:00.273Z",
            "status": "ACTIVE",
            "tags": null,
            "customAttributes": null,
            "primaryOwner": {
                "value": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                "displayName": "Amel MacLead"
            },
            "isOwner": false
        },
        {
            "id": "e158axd3-8575-4xff-892f-a293aa3c3d69",
            "name": "Database Auditing Policy",
            "description": "Establishes guidelines for auditing database activity, tracking user interactions, privilege changes, and compliance monitoring.",
            "createdBy": {
                "id": "globalId.12512xx3-eedc-4d6a-b6d4-6c0f6537bad2.18.02e36bbb4b20x421b44aa046b3ceb16a",
                "name": "Amel MacLead",
                "displayName": "Amel MacLead"
            },
            "timeCreated": "2024-08-05T10:36:24.472Z",
            "timeUpdated": "2025-04-06T09:01:57.908Z",
            "status": "ACTIVE",
            "tags": null,
            "customAttributes": null,
            "primaryOwner": {
                "value": null,
                "displayName": null
            },
            "isOwner": null
        }
    ]
}
}

先頭に戻る