リクエストの送信
Oracle Access Governance REST APIを使用してリクエストを送信する場合は、次のガイドラインを使用します。
URL構造の理解
リクエストのURL構造は次のとおりです:
https:<host>/path/resource-path
各項目の意味は次のとおりです。host | サービス・インスタンスのサブドメインおよびドメイン名。
|
path | API内のリソースを指定し、リソースを一意に識別するフルパス。
|
resource-path | リクエストされているリソース識別子。
|
サポートされるメソッド
標準のHTTPメソッド・リクエストを使用して、リソースに対して基本的なCRUD操作(作成、読取り、更新および削除)を実行できます。 各リソースでサポートされているエンドポイントを表示するには、「すべてのRESTエンドポイント」リストを参照してください。
ノート:
複数の操作を単一のHTTPリクエストにまとめてパフォーマンスを向上させることができます。メディア・タイプ
- 「認証」の場合
Content-Type: application/x-www-form-urlencoded
- 「リクエスト本文」の場合(コンテンツが必要なリクエストの場合)
Content-Type: application/json
- 「レスポンス」の場合
Content-Type: application/json
サポートされているヘッダー
Oracle Access Governance REST APIでは、HTTPリクエストまたはレスポンスのヘッダー・セクションで渡される可能性のある次のヘッダーがサポートされています。
ヘッダー | 説明 | 例 |
Authorization
|
リソースにアクセスする前にOAuth Bearerトークンが必要です。 |
Bearer <token value>
|
Content-Type
|
リクエストの本体のメディア・タイプ。 POSTおよびPUTリクエストで必要です。 |
|
opc-request-id
|
各レスポンスの一意のヘッダー識別子。 特定のリクエストに関するサポートに連絡する必要がある場合は、リクエストIDを指定します。 |
oci-12345678-2AAddffs
|
opc-next-page |
アイテムのリストが返された場合の一意のページ区切り識別子。 リストの一部が返された場合は、このトークンをpage パラメータに含めて次のバッチを取得します。
|
AAAAAWHT6XXXXMXXXXYQFES3XXX |
Content-Encoding |
レスポンス・ヘッダー | gzip |
Oracle Access Governance REST APIの標準問合せパラメータ
問合せパラメータを使用して、エンドポイント・レスポンスで返されるデータを制御できます。 エンドポイントごとに異なる問合せパラメータをサポートできます。 適用可能なパラメータとその使用方法を確認するには、特定のエンドポイント参照を参照してください。
${host}/access-governance/access-controls/20250331/accessBundles?sortOrder=DESC&sortBy=name&keywordContains=oci
次に、いくつかの標準問合せパラメータを示します:
パラメータ | 説明 | 例 |
---|---|---|
limit | レスポンスが大きくなりすぎないようにするには、これを使用してレスポンスを制限します。
|
?limit=20 |
sortOrder | 結果の取得時に使用するソート順。
許容値: |
?orderBy=ASC |
sortBy | ソートに使用される属性。 結果は、timeCreated 、name またはdisplayName でソートできます。
ノート: 適用可能な値を確認するには、特定のエンドポイントの詳細を参照してください。timeCreated は降順で、displayName は昇順で表示されます。
|
?sortBy=name |
keywordContains | 名前に指定されたキーワードの出現に基づいて結果をフィルタします。 名前に基づいて暗黙的にワイルドカード検索をサポートします。
ノート: 適用可能な値を確認するには、特定のエンドポイント参照を参照してください。たとえば、IDの場合は、姓、名、ユーザー名、プライマリEメール、マネージャ表示名およびアイデンティティ表示名を検索できます。 |
?keywordContains=oci |
ページ | ページ区切りに使用されます。 後続のページからのレスポンスを取得するには、前のコールで返されたopc-next-page から値を取得し、page 問合せパラメータに渡します
|
?page=<opc-next-page token from previous response> |