機械翻訳について

移動先

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

オーケストレーション・システムの権限のリストの取得

get

/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/permissions

ページ区切りをサポートしている、特定のオーケストレーション・システムに関連付けられた権限のリストを返します。

リクエスト

パス・パラメータ

• orchestratedSystemId(required): string
  オーケストレーション・システムの一意のID。 使用可能な値は、ListOrchestratedSystems操作を使用して確認できます。

問合せパラメータ

• domainName: string
  ドメイン名
• keywordContains: string
  次のフィールドからフィルタするキーワード: displayName. 指定できるキーワードは1つのみです。
• limit: integer
  最小値: 1

  最大値: 1000

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

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

  結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
• permissionTypeId: string
  権限の添付先の権限タイプのID。
• resourceType: string
  OCIシステムの権限をフェッチするためのリソース・タイプ・フィルタ。 orchestratedSystemタイプがOCIの場合は必須です。

  許容値: [ "APP_ROLE", "GROUP" ]
• sortBy: string
  ソートの基準となるフィールド。 指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。

  デフォルト値: timeCreated

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

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

ヘッダー・パラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

権限オブジェクトのページ

ヘッダー

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

本文()

ルート・スキーマ : PermissionCollection

型: object

権限検索の結果。 PermissionSummaryアイテム。

ソースを表示

• items(必須): array items
  PermissionSummaryのリスト

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of PermissionSummary",
            "items":{
                "$ref":"#/definitions/PermissionSummary"
            }
        }
    },
    "description":"Results of a Permission search. PermissionSummary items."
}

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

型: array

PermissionSummaryのリスト

ソースを表示

• Array of: object PermissionSummary
  権限の説明。

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

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

型: object

権限の説明。

ソースを表示

• description: string
  権限の説明
• id(必須): string
  作成時に不変である一意のOracle ID (OCID)
• name: string
  パーミッション名
• permissionType: object PermissionTypeSummary
  PermissionTypeサマリー。
• resource: object ResourceSummary
  資源要約
• timeCreated: string(date-time)
  権限が最後に作成された時間。 「An RFC3339」書式設定日時文字列
• timeUpdated: string(date-time)
  権限が最後に更新された時間。 「An RFC3339」書式設定日時文字列
• type: string
  権限のタイプ

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the permission"
        },
        "description":{
            "type":"string",
            "description":"Description of the permission"
        },
        "type":{
            "type":"string",
            "description":"Type of the permission"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the permission was last created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the permission was last updated. An RFC3339 formatted datetime string"
        },
        "resource":{
            "$ref":"#/definitions/ResourceSummary"
        },
        "permissionType":{
            "$ref":"#/definitions/PermissionTypeSummary"
        }
    },
    "description":"Description of Permission."
}

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

型: object

PermissionTypeサマリー。

ソースを表示

• displayName: string
  PermissionTypeの表示名。
• externalId: string
  PermissionTypeの外部ID
• id: string
  作成時に不変である一意のOracle ID (OCID)。
• name: string
  PermissionTypeの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"name of the PermissionType."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the PermissionType."
        },
        "externalId":{
            "type":"string",
            "description":"External Id of the PermissionType"
        }
    },
    "description":"PermissionType Summary."
}

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

型: object

資源要約

ソースを表示

• customAttributes: object customAttributes
  リソースに関連付けられたメタデータ
• displayName: string
  リソースの表示名。
• id(必須): string
  作成時に不変である一意のOracle ID (OCID)。
• name: string
  リソースの名前。
• type: string
  リソースのタイプ

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"name of the Resource."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Resource."
        },
        "type":{
            "type":"string",
            "description":"Type of the Resource"
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the resource",
            "properties":{
            }
        }
    },
    "description":"Resource Summary."
}

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

型: object

リソースに関連付けられたメタデータ

ソースを表示

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

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>" \
'${service-instance-url}/access-governance/service-administration/20250331/orchestratedSystems/${orchestratedSystemId}/permissions'

RESTクライアントを使用したGETコマンドの例

curl -i -X GET \
   -H "Authorization:Bearer <your access token> \
'${service-instance-url}/access-governance/service-administration/20250331/orchestratedSystems/e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a/permissions'

レスポンス本文の例

次の例は、アカウント・プロファイルを含むJSON形式のレスポンス本文のコンテンツを示しています:

{
    "items": [
        {
            "id": "groups.ICF.exaaxfxx-9eed-4a25-b8cc-a0xc3fb2xxxa.95dexxxcbxxxe0df8af649dx709915e0",
            "name": "AD_JML_GRP1",
            "description": null,
            "type": null,
            "timeCreated": "2024-08-12T13:44:07.205Z",
            "timeUpdated": null,
            "resource": {
                "id": "resource.ICF.e4aaxfxx-9eed-4axx-b8cc-a04c3fb2xxxa.exxxxxxe46exxa61exd7f067fc39be6f",
                "name": "AD System AG_App_Owner_Admin",
                "displayName": "AD System AG_App_Owner_Admin",
                "type": "RESOURCES",
                "customAttributes": null
            },
            "permissionType": {
                "id": "etype.ICF.e4aa3f66-9eed-xaxx-b8cc-axxc3fb2dxxa.936d9be0ce4c3ce91dxxxxc59cdaeaa3",
                "name": "icf.connector.entitlement.type.groups",
                "displayName": "Group",
                "externalId": "groups"
            }
        },
       {
            "id": "groups.ICF.exxx3f66-9eed-4axx-b8cc-a04c3fbxxxxa.edba9bxxxxxa0e7f0xxxxxxc99d1axxx",
            "name": "AD_JML_PERSONAS1",
            "description": null,
            "type": null,
            "timeCreated": "2024-08-12T14:34:43.034Z",
            "timeUpdated": null,
            "resource": {
                "id": "resource.ICF.e4aa3fxx-9xxx-4axx-b8cc-a04c3fbxxxxa.e427125e46e48a61e2d7f067fcxxxe6f",
                "name": "AD System AG_App_Owner_Admin",
                "displayName": "AD System AG_App_Owner_Admin",
                "type": "RESOURCES",
                "customAttributes": null
            },
            "permissionType": {
                "id": "etype.ICF.e4aa3f66-9eed-4axx-b8cc-a04c3fbxxx4a.9xxd9be0ce4c3cexxdxxx1c59cdaeaax",
                "name": "icf.connector.entitlement.type.groups",
                "displayName": "Group",
                "externalId": "groups"
            }
        }
    ]
}

先頭に戻る