Oracle® Fusion Middleware Oracle Platform Security Services REST API 12c (12.2.1.2.0) E82644-02 |
|
前 |
次 |
この章の内容は次のとおりです。
OPSS REST APIにより、RESTインタフェースを介してコアなOPSS機能にアクセスできるようになります。このREST APIにより、様々な言語およびプラットフォームでOPSSサービスが使用できます。さらに、APIによって、対応する言語固有のAPIが実装されるのを待つことなくアプリケーションで新しい機能を使用する柔軟性も提供されます。
このリファレンスで説明しているサービスには、次のサービスが含まれます。
登録サービス – クライアントをOPSSに登録するために使用するサービス。その他のサービスを使用するには、クライアントをOPSSに登録する必要があります。「OPSSクライアントの登録」を参照してください。
資格証明サービス – 資格証明の作成および表示に使用されるサービス。「資格証明ストアでの資格証明の管理」を参照してください。
キーストア・サービス – キーストアの管理に使用されるサービス。「キーストアの管理」を参照してください。
トラスト・サービス – トラスト・トークンの作成および検証に使用されるサービス。「トラスト・トークンの作成および検証」を参照してください。
認可サービス – ポリシー決定ポイント・システムを使用してリソースへのアクセスを認可するのに使用されるサービス。「アクセスの認可」を参照してください。
注意:
OPSS REST APIサービスをデプロイするには、ドメインにOPSS RESTサービス・アプリケーション・テンプレートが含まれる必要があります。ドメインを作成する際にこのテンプレートを選択することも、既存のドメインを拡張してそれを含めることもできます。詳細は、以下のトピックを参照してください。
構成ウィザードによるWebLogicドメインの作成
の、Fusion Middlewareドメインの構成
ドメイン・テンプレート・リファレンス
のOracle OPSS RESTサービス・アプリケーション・テンプレートの詳細
セキュリティの管理には、次のURLを使用します。
https://host:port/opss/v2/resource
各要素の意味は次のとおりです。
host
:port: Oracle Fusion Middlewareを実行しているホストおよびポート。
resource
: RESTリソースを定義する相対パス。使用可能なリソースはこのガイドの中で説明しています。各リソースを定義するWeb Application Definition Language (WADL)ドキュメントにアクセスするには、URLでapplication.wadl
を指定します。次に例を示します。
https://host:port/opss/v2/application.wadl
Oracle Fusion Middleware RESTリソースにHTTPでアクセスし、Oracle WebLogic Server管理者のユーザー名とパスワードを入力する必要があります。
たとえば、cURLを使用して認証するには、-u
cURLオプションを使用してユーザー名とパスワードを渡します。
curl -i -X GET -u username:password https://myhost:7001/opss/v2/keystore
リクエスト本文でデータを送信しないGET
およびDELETE
メソッドでは、キーストアまたはキーがパスワードで保護されている場合、カスタム・ヘッダーで、Base64で暗号化されたキーストアおよびキーのパスワードを渡す必要があります。次に例を示します。
curl -i -X DELETE -u username:password -H keystorePassword:cHdkMQ== -H keyPassword:bXlQd2Qy https://myhost:7001/opss/v2/keystoreservice?"stripeName=myStripe&keystoreName=myKeystore"
OPSS RESTエンドポイントでは、標準HTTPセマンティクスをサポートします。
RESTメソッド | タスク |
---|---|
|
RESTリソースに関する情報を取得します。 |
|
RESTリソースを追加します。 |
|
RESTリソースを更新します。 |
|
RESTリソースを削除します。 |
この項で説明されているリソースの操作に使用されるHTTPメソッドは、次のHTTPステータス・コードのいずれかを返します。
HTTPステータス・コード | 説明 |
---|---|
200 OK |
リクエストは正常に完了しました。ステータス200は、 |
201 Created |
要求が満たされ、新規リソースが作成されます。レスポンスには、新たに作成されたリソースの正規のURIを含むLocationヘッダーが含まれています。 ステータス201は、同期リソースの作成、またはレスポンスが返される前に完了した非同期リソースの作成から返されます。 |
202 Accepted |
要求の処理は受け入れられましたが、処理は完了していません。要求は、実際に処理される時に拒否される可能性があるため、最終的に処理されない場合もあります。 非同期( クライアントは、レスポンスに含まれるジョブ・リソースのLocationヘッダーを調べて、ジョブが終了した時期を確認する必要があります。ジョブの現在の状態を表すエンティティも返されます。 |
400 Bad Request |
情報が欠落しているか不適切であるため(入力フィールドの検証エラー、必須値の欠落など)、リクエストを処理できませんでした。 |
401 Unauthorized |
リクエストが認可されていません。このリクエストに認証資格証明がないか、または無効です。 |
403 Forbidden |
ユーザーを認証できません。ユーザーにはこのリクエストを実行する権限がありません。 |
404 Not Found |
リクエストには、存在しないリソースURIが含まれています。 |
405 Method Not Allowed |
リクエストに指定されたHTTP動詞( |
406 Not Acceptable |
このリクエストによって識別されたリソースは、リクエストのAcceptヘッダーのいずれかのメディア・タイプに対応する表現を生成できません。たとえば、クライアントのAcceptヘッダーがXMLを返すように要求しているが、リソースとして返すことができるのはJSONのみである場合。 |
415 Not Acceptable |
クライアントのContentTypeヘッダーが正しくありません(たとえば、クライアントがXMLでリクエストを送信しようとしたが、リソースがJSONのみを受理できる場合)。 |
500 Internal Server Error |
サーバーに予期せぬ状態が発生し、リクエストを処理できませんでした。 |
503 Service Unavailable |
サーバーが一時的に高負荷の状態にあるかメンテナンス中であるため、リクエストを処理できません。Oracle WSM REST Webアプリケーションは現在実行されていません。 |