Oracle Access Governance REST APIs

機械翻訳について

アクセス・バンドルのリストの取得

get

/access-governance/access-controls/20250331/accessBundles

ページ区切りをサポートするすべての使用可能なアクセス・バンドルの詳細を返します。

リクエスト

問合せパラメータ

approvalWorkflowId: string

最小長: 1

最大長: 255

指定された承認ワークフローIDに一致するリソースのみを返すフィルタ。
keywordContains: string

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

最小値: 1

最大値: 1000

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

デフォルト値: 10
orchestratedSystemId: string

最小長: 1

最大長: 255

指定されたオーケストレーション・システム識別子と一致するリソースのみを返すフィルタ。
page: string

最小長: 1

結果の取得を開始する位置を表すトークン。これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
requestableBy: string

最小長: 1

最大長: 255

指定されたidentityTypeに一致するリソースのみを返すフィルタ。

許容値: [ "ANY", "NONE" ]
sortBy: string

指定されたソート基準フィールドでアクセス・バンドルをソートするために使用するフィルタ。指定できるソート順は1つのみです。

デフォルト値: timeUpdatedOn

許容値: [ "name", "timeUpdated", "createdBy" ]
sortOrder: string

使用するソート順(ASCまたはDESC)。

許容値: [ "ASC", "DESC" ]
status: string

指定されたステータスのエンティティの検索に使用するフィルタ。

デフォルト値: ALL

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

最小長: 1

最大長: 255

操作を実行しているユーザーの識別子

ヘッダー・パラメータ

opc-request-id: string

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

トップに戻る

レスポンス

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

application/json

200レスポンス

アクセス・バンドル・サマリーのリスト

ヘッダー

opc-next-page: string

アイテム・リストのページ区切り。リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
opc-request-id: string

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

ルート・スキーマ : AccessBundleCollection

型: object

アクセス・バンドル・リスト・リクエストの結果。

ソースを表示

items(必須): array items

アクセス・バンドルのサマリーのリスト。

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Access Bundle summaries.",
            "items":{
                "$ref":"#/definitions/AccessBundleSummary"
            }
        }
    },
    "description":"Results of an Access Bundle list request."
}

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

型: array

アクセス・バンドルのサマリーのリスト。

ソースを表示

Array of: object AccessBundleSummary

バンドル・サマリー・オブジェクトにアクセスします。

{
    "type":"array",
    "description":"List of Access Bundle summaries.",
    "items":{
        "$ref":"#/definitions/AccessBundleSummary"
    }
}

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

型: object

バンドル・サマリー・オブジェクトにアクセスします。

ソースを表示

accessTimeLimit: object AccessBundleTimeLimit

時間制限の定義。 daysLimit、hoursLimitまたはdateTimeLimitのいずれか1つのみを指定する必要があります。
accessTimeLimitType: string

許容値: [ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ]

アクセス・バンドルの時間制限タイプ。
approvalWorkflowId: string

アクセス・バンドルに適用可能な承認ワークフローのID。
createdBy: object IdInfo

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

アクセス・バンドルに関連付けられたカスタム属性。
description: string

バンドルの説明にアクセスします。
id(必須): string

システムによる作成時に不変である一意の識別子。
isOwner: boolean

コール元のアイデンティティがアクセス・バンドルの所有者である場合はtrue。
name: string

バンドル名にアクセスします。
orchestratedSystem: object IdInfo

汎用識別情報オブジェクト。
primaryOwner: object PrimaryOwner

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

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

アクセス・バンドルをリクエストできるアイデンティティ・タイプ。
status: string

許容値: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]

アクセス・バンドルのステータス。
tags: array tags

アクセス・バンドルに添付されたタグのリスト。
timeCreated: string(date-time)

アクセス・バンドルが作成された時間。 RFC3339形式の日時文字列
timeUpdated: string(date-time)

アクセス・バンドルが最後に更新された時間。 RFC3339形式の日時文字列

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation by the system."
        },
        "name":{
            "type":"string",
            "description":"Access Bundle name."
        },
        "description":{
            "type":"string",
            "description":"Access Bundle description."
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Access Bundle.",
            "items":{
                "type":"string"
            }
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string."
        },
        "createdBy":{
            "$ref":"#/definitions/IdInfo"
        },
        "requestableBy":{
            "type":"string",
            "description":"The identity type that may request the Access Bundle.",
            "enum":[
                "ANY",
                "NONE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/RequestableBy"
        },
        "status":{
            "type":"string",
            "description":"Status of the Access Bundle.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityStatus",
            "x-default-description":"ACTIVE"
        },
        "approvalWorkflowId":{
            "type":"string",
            "description":"The id of the approval workflow that is applicable to the Access Bundle."
        },
        "orchestratedSystem":{
            "$ref":"#/definitions/IdInfo"
        },
        "primaryOwner":{
            "$ref":"#/definitions/PrimaryOwner"
        },
        "isOwner":{
            "type":"boolean",
            "description":"True if the identity of the caller is the owner of the Access Bundle."
        },
        "customAttributes":{
            "type":"object",
            "description":"Custom attributes associated with the Access Bundle.",
            "properties":{
            }
        },
        "accessTimeLimitType":{
            "type":"string",
            "description":"Time limit type of the access bundle.",
            "enum":[
                "INDEFINITELY",
                "NUMBER_OF_DAYS",
                "NUMBER_OF_HOURS"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccessBundleTimeLimitType",
            "x-default-description":"INDEFINITELY"
        },
        "accessTimeLimit":{
            "$ref":"#/definitions/AccessBundleTimeLimit"
        }
    },
    "description":"Access Bundle summary object."
}

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

型: object

時間制限の定義。 daysLimit、hoursLimitまたはdateTimeLimitのいずれか1つのみを指定する必要があります。

ソースを表示

daysLimit: object AccessBundleTimeLimitDays

時間制限の定義(日数)。
hoursLimit: object AccessBundleTimeLimitHours

時間制限の定義(時間)。

{
    "type":"object",
    "properties":{
        "daysLimit":{
            "$ref":"#/definitions/AccessBundleTimeLimitDays"
        },
        "hoursLimit":{
            "$ref":"#/definitions/AccessBundleTimeLimitHours"
        }
    },
    "description":"Time limit definition. Only one of daysLimit, hoursLimit, or dateTimeLimit should be specified.\n"
}

ネストされたスキーマ : 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":"Custom attributes 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 Access Bundle.",
    "items":{
        "type":"string"
    }
}

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

型: object

時間制限の定義(日数)。

ソースを表示

accessLimitInDays(required): integer

最小値: 1

最大値: 365

失効までに許可される最大日数。
extensionApprovalWorkflowId(required): object IdInfo

汎用識別情報オブジェクト。
extensionInDays(required): integer

最小値: 1

最大値: 90

拡張が許可される日数。
notificationInDays(required): integer

最小値: 1

最大値: 30

通知を送信する日数。

{
    "type":"object",
    "required":[
        "accessLimitInDays",
        "extensionApprovalWorkflowId",
        "extensionInDays",
        "notificationInDays"
    ],
    "properties":{
        "accessLimitInDays":{
            "type":"integer",
            "description":"Maximum number of days allowed before expiry.",
            "minimum":1,
            "maximum":365
        },
        "notificationInDays":{
            "type":"integer",
            "description":"Number of days when notification should be sent.",
            "minimum":1,
            "maximum":30
        },
        "extensionInDays":{
            "type":"integer",
            "description":"Number of days extensions is allowed.",
            "minimum":1,
            "maximum":90
        },
        "extensionApprovalWorkflowId":{
            "$ref":"#/definitions/IdInfo"
        }
    },
    "description":"Time limit definition in days."
}

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

型: object

時間制限の定義(時間)。

ソースを表示

accessLimitInHours(required): integer

最小値: 1

最大値: 24

失効までに許可される最大時間数。
extensionApprovalWorkflowId(required): object IdInfo

汎用識別情報オブジェクト。
extensionInHours(required): integer

最小値: 1

最大値: 8

時間数の延長が許可されています。
notificationInHours(required): integer

最小値: 1

最大値: 24

通知を送信する時間数。

{
    "type":"object",
    "required":[
        "accessLimitInHours",
        "extensionApprovalWorkflowId",
        "extensionInHours",
        "notificationInHours"
    ],
    "properties":{
        "accessLimitInHours":{
            "type":"integer",
            "description":"Maximum number of hours allowed before expiry.",
            "minimum":1,
            "maximum":24
        },
        "notificationInHours":{
            "type":"integer",
            "description":"Number of hours when notification should be sent.",
            "minimum":1,
            "maximum":24
        },
        "extensionInHours":{
            "type":"integer",
            "description":"Number of hours extension is allowed.",
            "minimum":1,
            "maximum":8
        },
        "extensionApprovalWorkflowId":{
            "$ref":"#/definitions/IdInfo"
        }
    },
    "description":"Time limit definition in hours."
}

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://<host>/access-governance/access-controls/20250331/accessBundles'

cURL例 - 問合せパラメータあり

データを制限し、アクティブなアクセス・バンドルのみを含めるcURLコマンド。

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<host>/access-governance/access-controls/20250331/accessBundles?status=ACTIVE&limit=4'

レスポンス本文の例

次の例は、使用可能なすべてのアクセス・バンドルのリストを含む、JSON形式のレスポンス本文のコンテンツを示しています:

{
    "items": [
        {
            "id": "539fde4f-874b-40b6-8bb8-663cdc8a93e8",
            "name": "StandardAccess",
            "description": "Standard Access",
            "tags": null,
            "timeCreated": "2025-03-16T06:45:33.607Z",
            "timeUpdated": "2025-03-16T06:45:33.607Z",
            "createdBy": {
                "id": "globalId.OCI.OCI-System.1234563xxxxxxxx",
                "name": "Bill Clark",
                "displayName": "Bill Clark"
            },
            "requestableBy": "ANY",
            "status": "ACTIVE",
            "approvalWorkflowId": "NO_APPROVAL_REQUIRED",
            "orchestratedSystem": {
                "id": "1234567-37ad-4ac5-884b-xxxxx",
                "name": "mock-flat-file",
                "displayName": "mock-flat-file"
            },
            "accessBundleType": "PERMISSION_BUNDLE",
            "primaryOwner": {
                "value": "globalId.OCI.OCI-System.1234563xxxxxxxx",
                "displayName": "Bill Clark"
            },
            "isOwner": false,
            "customAttributes": null
        }
    ]
}

先頭に戻る