Oracle® Fusion Middleware

Oracle Web Services Managerでの資格証明およびキーストアの管理のためのREST API

リリース12c 12.2.1.2

E82845-01(原本部品番号:E78152-01)

2016年10月

このドキュメントでは、Oracle Web Services Managerで資格証明ストア、キーストアおよびトラスト・ストアを管理するためのREST APIの使用方法を説明します。

Oracle Fusion Middleware Oracle Web Services Managerでの資格証明およびキーストアの管理のためのREST API、リリース12c 12.2.1.2

E82845-01

Copyright © 2013, 2016, Oracle and/or its affiliatesAll rights reserved.

原本著者: Oracle Corporation

原本協力著者: Sudhira Subudhi

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

例一覧

図一覧

表一覧

タイトルおよび著作権情報

はじめに

- ドキュメントのアクセシビリティについて

- 表記規則

このガイドで説明する新機能

- リリース12c (12.2.1.1)の新機能と変更された機能

第I部 REST APIスタート・ガイド

1 REST APIについて

- 1.1 REST APIの概要

- 1.2 セキュリティ・ストアのURL構造

- 1.3 RESTを使用したOracle WSMインスタンスの作成と管理

- 1.4 RESTリソースの認証

- 1.5 HTTPメソッドのHTTPステータス・コード

2 REST APIの使用事例

- 2.1 REST APIによる資格証明ストア・フレームワークの管理

- 2.2 REST APIによるJKSキーストアの管理

- 2.3 REST APIによるKSSキーストアの管理

- 2.4 REST APIによるトークン発行者の信頼の管理

第II部 REST APIリファレンス

3 資格証明ストア内の資格証明の管理

- 3.1 RESTリソースを使用した資格証明ストアの参照と管理

- 3.2 資格証明のPOSTメソッド

- 3.3 資格証明のGETメソッド

- 3.4 資格証明のPUTメソッド

- 3.5 資格証明のDELETEメソッド

4 Javaキーストアのキーストア管理

- 4.1 RESTリソースを使用したドメイン内のJKSキーストアの参照と管理

- 4.2 JKSキーストアの信頼できる証明書のすべての別名のGETメソッド

- 4.3 JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド

- 4.4 JKSキーストアのPKCS#7の信頼できる証明書のPOSTメソッド

- 4.5 JKSキーストアの信頼できる証明書の指定した別名のGETメソッド

- 4.6 JKSキーストアの信頼できる証明書のDELETEメソッド

5 キーストア・サービスのキーストアの参照と管理

- 5.1 RESTリソースを使用したKSSキーストアの参照と管理

- 5.2 新しいKSSキーストアのPOSTメソッド

- 5.3 KSSキーストアをインポートするPOSTメソッド

- 5.4 KSSキーストアのパスワードを更新するPUTメソッド

- 5.5 KSSキーストアの信頼できる証明書のPOSTメソッド

- 5.6 ストライプのKSSキーストアのGETメソッド

- 5.7 KSSキーストアの別名のGETメソッド

- 5.8 KSSキーストアの信頼できる証明書のGETメソッド

- 5.9 KSSキーストアの信頼できる証明書のDELETEメソッド

- 5.10 KSSキーストアの秘密鍵プロパティのPOSTメソッド

- 5.11 KSSキーストアの秘密鍵プロパティのGETメソッド

- 5.12 キーストア・サービスKSSキーストアのDELETEメソッド

6 トークン発行者の信頼構成の管理

- 6.1 RESTリソースを使用したトークン発行者の信頼構成の参照と管理

- 6.2 信頼ドキュメント名のPOSTメソッド

- 6.3 ドメインの信頼できる発行者と識別名リストのPOSTメソッド

- 6.4 ドキュメントの信頼できる発行者と識別名リストのPOSTメソッド

- 6.5 すべての信頼できる発行者と識別名リストのGETメソッド

- 6.6 特定のドキュメントの信頼できる発行者と識別名リストのGETメソッド

- 6.7 トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)

- 6.8 トークン属性ルール識別名のPOSTメソッド(ドキュメント・コンテキスト)

- 6.9 すべてのトークン属性のGETメソッド

- 6.10 指定したドキュメント・トークン属性ルールのGETメソッド

- 6.11 信頼ドキュメント名の構成のインポート・メソッド

- 6.12 信頼ドキュメントのGETメソッド

- 6.13 信頼ドキュメントのDELETEメソッド

A REST APIのサマリー

例の一覧

図一覧

表一覧

はじめに

ここでは、このガイド『Oracle Web Services Managerでの資格証明およびキーストアの管理のためのREST API』のドキュメントのアクセシビリティ機能および規則について説明します。

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティへの取り組みについては、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)にアクセスしてください。

Oracleサポートへのアクセス

サポートを購入したオラクル社のお客様は、My Oracle Supportを介して電子的なサポートにアクセスできます。詳細は、http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info、聴覚に障害があるお客様はhttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=trsを参照してください。

表記規則

このマニュアルでは次の表記規則を使用します。

表記規則

意味

太字

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

斜体

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

固定幅フォント

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

このガイドで説明する新機能

この項では、Oracle Fusion Middleware 12c (12.2.1)リリースにおけるOracle Web Services Managerの新機能および製品の重要な変更点の概要を示します。

リリース12c (12.2.1.1)の新機能と変更された機能

Oracle Fusion Middlewareリリース12c (12.2.1.1)については、このドキュメントに記載されている新機能および変更された機能はありません。

第I部REST APIスタート・ガイド

Oracle Fusion Middleware REST APIを使用して資格証明およびキーストアの管理を開始する必要があります。

第I部は、次の章で構成されています。

- REST APIについて

- REST APIの使用事例

1 REST APIについて

この章では、資格証明およびキーストアの管理のためのOracle Fusion Middleware Representational State Transfer (REST) APIの概要を示します。

次のトピックが含まれています:

- REST APIの概要

- セキュリティ・ストアのURL構造

- RESTを使用したOracle WSMインスタンスの作成と管理

- RESTリソースの認証

- HTTPメソッドのHTTPステータス・コード

1.1 REST APIの概要

資格証明およびキーストアを管理するREST APIは、ドメインおよびWebサービスの資格証明ストア、キーストアおよびトラスト・ストアを作成および構成するためのエンドポイントを提供します。

RESTエンドポイントには、Webブラウザとクライアント・アプリケーションからアクセスできます。

Oracle WSM RESTエンドポイントは、次のような言語で開発されたRESTクライアント・アプリケーションで使用することもできます。

- JavaScript

- Ruby

- Perl

- Java

- JavaFX

REST APIを使用する前に、次の項で説明するいくつかの重要なコンセプトを理解する必要があります。

1.2 セキュリティ・ストアのURL構造

特定のURL構造を使用してセキュリティ・ストアを管理できます。

セキュリティ・ストアの管理には、次のURLを使用します。

http(s)://host:port/idaas/contextpath/admin/v1/resource

各項目の意味は次のとおりです。

- host:port: Oracle Fusion Middlewareを実行しているホストおよびポート。

- contextpath: RESTリソースのコンテキスト・パス。この値は、ドメイン全体に適用されるリソース(キーストア管理や資格証明管理のリソースなど)の場合はplatform、特定のWebサービスに適用されるリソース(信頼管理のリソースなど)の場合はwebserviceに設定できます。

- resource: RESTリソースを定義する相対パス。詳細は、「REST APIリファレンス」を参照してください。Web Application Definition Language (WADL)ドキュメントにアクセスする場合は、application.wadlを指定します。

1.3 RESTを使用したOracle WSMインスタンスの作成と管理

Oracle WSM RESTエンドポイントは、Oracle WSMインスタンスを作成および管理するための標準メソッドをサポートします。

RESTメソッド

タスク

GET

RESTリソースに関する情報を取得します。

POST

RESTリソースを追加します。

PUT

RESTリソースを更新します。

DELETE

RESTリソースを削除します。

1.4 RESTリソースの認証

Oracle Fusion Middleware RESTリソースにHTTPでアクセスできますが、Oracle WebLogic Server管理者のユーザー名とパスワードを入力する必要があります。

たとえば、cURLを使用して認証するには、-u cURLオプションを使用してユーザー名とパスワード(たとえば、weblogicとwelcome1)を渡します。

curl -i -X GET -u weblogic:welcome1 http://myhost:7001/idaas/platform/admin/v1/keystore

リクエスト本文でデータを送信しないPOSTおよびDELETEメソッドでは、キーストアまたはキーがパスワードで保護されている場合、カスタム・ヘッダーで、Base64で暗号化されたキーストアおよびキーのパスワードを渡す必要があります。次に例を示します。

curl -i -X DELETE -u weblogic:welcome1 -H keystorePassword:cHdkMQ== -H keyPassword:bXlQd2Qy  http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myAlias"

1.5 HTTPメソッドのHTTPステータス・コード

このトピックで説明するリソースの操作に使用するHTTPメソッドは、次のHTTPステータス・コードのいずれかを返します。

HTTPステータス・コード

説明

200 OK

リクエストが正常に完了されました。ステータス200は、GETまたはPOSTメソッドが成功した場合に返されます。

201 Created

リクエストが完了し、新規のリソースが作成されました。レスポンスには、新規作成されたリソースの正規URIを含むロケーション・ヘッダーが含まれます。

201ステータスは、レスポンスが返されるより前に完了した同期リソース作成または非同期リソース作成から返されます。

202 Accepted

リクエストの処理は承認されましたが、処理がまだ完了していません。実際の処理が発生するときにリクエストが拒否される可能性もあるため、リクエストが実際に実行されるかどうかは未定です。

非同期(__detached=true)リソース作成を指定する(アプリケーションのデプロイ時など)、または更新を指定する(アプリケーションの再デプロイ時など)場合は、操作がまだ進行中でも202が返されます。__detached=falseの場合、基礎となる操作が妥当な時間内で完了しない場合に202が返されることもあります。

レスポンスには、ジョブが完了するタイミングを判定するためにクライアントがポーリングするジョブ・リソースのロケーション・ヘッダーが含まれます。また、ジョブの現在のステータスを含むエンティティを返します。

400 Bad Request

情報が欠落しているか無効なため(たとえば、入力フィールドに検証エラーがある、必須の値が欠落しているなど)、リクエストを処理できませんでした。

401 Unauthorized

リクエストは承認されません。このリクエストに含まれていた認証資格証明が欠落しているか無効です。

403 Forbidden

ユーザーを認証できません。このリクエストを実行する権限がユーザーにありません。

404 Not Found

リクエストに、存在しないリソースURIが含まれています。

405 Method Not Allowed

リクエストで指定されたHTTP動詞(DELETE、GET、POST、PUT)が、このリクエストURIではサポートされていません。

406 Not Acceptable

このリクエストで指定されたリソースは、リクエストのAcceptヘッダーにあるメディア・タイプのいずれかに対応する表現を生成できません。たとえば、クライアントのAcceptヘッダーではXMLを返すようにリクエストされていますが、リソースはJSONしか返しません。

415 Not Acceptable

クライアントのContentTypeヘッダーが正しくありません(たとえば、クライアントがXMLでリクエストを送信しようとしたが、リソースはJSONしか受け付けないなど)。

500 Internal Server Error

サーバーで予期しない状態が発生し、リクエストを処理できませんでした。

503 Service Unavailable

サーバーが一時的な過負荷またはメンテナンス状態にあるため、サーバーがリクエストを処理できません。Oracle WSM REST Webアプリケーションは現在実行されていません。

2 REST APIの使用事例

この章では、REST APIの使用事例をいくつか示します。

- REST APIによる資格証明ストア・フレームワークの管理

- REST APIによるJKSキーストアの管理

- REST APIによるKSSキーストアの管理

- REST APIによるトークン発行者の信頼の管理

2.1 REST APIによる資格証明ストア・フレームワークの管理

REST APIを使用して、資格証明ストア・フレームワークを参照および管理できます。

次の方法を使用事例で示します。

- 資格証明ストアの資格証明の作成

- 資格証明ストアのすべての資格証明の参照

- 資格証明ストアからの資格証明の削除

注意:

資格証明ストアの管理の詳細は、『Webサービスの管理』の資格証明ストアの構成に関する項を参照してください。

テスト済

REST APIを使用して資格証明ストア・フレームワークを管理する手順:

1. 次の手順を実行して、資格証明ストア・フレームワークに資格証明を作成します。

a. 作成する資格証明を定義するJSONドキュメント(createcred.json)を作成します。
リクエスト・ドキュメントの例を次に示します。この例では、資格証明マップ名はdefault、資格証明キーはmyKey、ユーザー名とパスワードの資格証明はmyUsrとmyPwdです。

{
"username" : "username",
"credential" : "pwd",
"key" : "mykey",
"map" : "oracle.wsm.security"
}

リクエストの属性の詳細は、「資格証明のPOSTメソッド」を参照してください。

b. cURLを使用して、前のステップで定義したJSONドキュメントを渡して資格証明ストア・フレームワークに資格証明を作成します。

curl -i -X POST -u username:password --data @createcred.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/credential

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS": "Succeeded"
}

詳細は、「資格証明のPOSTメソッド」を参照してください。

2. 資格証明ストアのすべての資格証明を参照します。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/credential

次は、資格証明ストアのすべての資格証明を示しているレスポンスの例です。

{
"CSF_MAP_NAME": "CSF_KEY_NAME",
"default": "systemuser",
"oracle.wsm.security": [
"sign-csf-key",
"jwt-sign-csf-key",
"owsmtest.credentials",
"basic.client.credentials",
"weblogic-csf-key",
"enc-csf-key",
"mykey",
"dummy-pwd-csf-key",
"weblogic-kerberos-csf-key",
"keystore-csf-key",
"weblogic-windowsdomain-csf-key",
"oratest-csf-key",
"csr-csf-key",
"invalid-csf-key",
"ca-signed-sign-csf-key"
]
}

詳細は、「資格証明のGETメソッド」を参照してください。

3. 資格証明ストアから資格証明を削除します。

curl -i -X DELETE -u username:password http://myhost:7001/idaas/webservice/admin/v1/credential?"key=mykey&map=oracle.wsm.security"

削除する資格証明ストアに関連付けられたマップおよびキーの名前を定義するために問合せパラメータを渡す必要があります。詳細は、「資格証明のDELETEメソッド」を参照してください。

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS": "Succeeded"
}

2.2 REST APIによるJKSキーストアの管理

REST APIを使用して、現在のドメイン内でJavaキーストア(JKS)証明書を参照および管理できます。

次の方法を使用事例で示します。

- JKSキーストア内のすべての別名を参照する。

- JKSキーストアに信頼できる証明書をインポートする。

- JKSキーストアの信頼できる証明書を参照する。

- JKSキーストアから信頼できる証明書を削除する。

注意:

JKSキーストアの管理の詳細は、『Webサービスの管理』のメッセージ保護のためのキーストアの構成に関する項を参照してください。

テスト済

REST APIを使用してJKSキーストアを管理する手順:

1. 現在のドメイン内のJKSキーストアに存在するすべての別名を参照します。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystore

次は、JKSキーストアのすべての別名を示しているレスポンスの例です。

{
"aliases":"oratest,orakey,testkey,jkstest,ms-oauthkey"
}

詳細は、「JKSキーストアの信頼できる証明書のすべての別名のGETメソッド」。

2. 次の手順を実行して、指定した別名でJKSキーストアに信頼できる証明書をインポートします。

a. JKSキーストアにインポートされる信頼できる証明書を定義するJSONドキュメント(importjks.json)を作成します。
リクエスト・ドキュメントの例を次に示します。この例では、信頼できる証明書をBase64でエンコードし、コンポーネント・タイプはこのリリースのJKSに設定する必要があります。

{   "component":"JKS",
"certificate": "MIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAwSDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECxMBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYTAXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBAMTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/gLZRJmlFXUAiUftZPY1Y+r/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQIsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu/yIgMZndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX2g3GotHd7Kht/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9bhSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBBYEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH/G1ixrEaWAG3lGWafkHgXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c="
}

リクエストの属性の詳細は、「JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド」を参照してください。

b. cURLを使用して、インポートする信頼できるキーの別名(mytestkey)を指定し、前のステップで定義したJSONリクエスト・ドキュメントを渡して、信頼できる証明書をインポートします。

curl -i -X POST -u username:password -H Content-type:application/json --data @importjks.json http://myhost:7001/idaas/platform/admin/v1/keystore/mytestkey

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS":"Succeeded",
"SUBJECT_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y"
}

詳細は、「JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド」を参照してください。

3. ステップ3でインポートした信頼できる証明書を参照します。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystore/mytestkey

次に信頼できる証明書の詳細が示されたレスポンスの例を示します。

{
"SUBJECT_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
"ISSUER_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
"NOT_BEFORE":"Thu Jul 03 04:00:16 PDT 2014",
"NOT_AFTER":"Wed Oct 01 04:00:16 PDT 2014",
"SERIAL_NO":"1784168778",
"SIGNING_ALGORITHM":"1.2.840.10040.4.3",
"CONTENT":"-----BEGIN CERTIFICATE-----\
nMIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAw
SDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECx
MBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYT
AXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBA
MTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA\/X9TgR11EilS30qcLuzk5\/YRt1I870QAwx4\/g
LZRJmlFXUAiUftZPY1Y+r\/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5\/oBHsQIsJPu6nX\/rfG
G\/g7V+fGqKYVDwT7g\/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu\/yIgMZndFIAccCFQCXYFCPFSMLzLK
SuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu\/o66oL5V0wLPQeCZ1FZV4661FlP5nEH
EIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qF
GQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7\/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX
2g3GotHd7Kht\/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9b
hSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBB
YEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH\/G1ixrEaWAG3lGWafkH
gXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c=\n-----END CERTIFICATE-----",
"SIGNATURE": "7JmdaAc+5T+spDFFo9gsRA==",
"Extensions": "{subjectKeyIDExtension {oid = 2.5.29.14, critical = false, value = f74ca5c1016d848260c749884e2b710c5fecc7b8}}"
}

詳細は、「JKSキーストアの信頼できる証明書の指定した別名のGETメソッド」を参照してください。

4. JKSキーストアから信頼できる証明書を削除します。

curl -i -X DELETE -u username:password http://myhost:7001/idaas/platform/admin/v1/keystore/mytestkey

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS": "Succeeded"
}

詳細は、「JKSキーストアの信頼できる証明書のDELETEメソッド」を参照してください。

2.3 REST APIによるKSSキーストアの管理

REST APIを使用して、キーストア・サービス(KSS)キーストアを参照および管理できます。

次の方法を使用事例で示します。

- KSSキーストアの作成

- ストライプのすべてのKSSキーストアの参照

- KSSキーストアへの信頼できる証明書のインポート

- JKSキーストアの信頼できる証明書の参照

- KSSキーストアの削除

注意:

KSSキーストアの管理の詳細は、『Webサービスの管理』のメッセージ保護のためのOPSSキーストア・サービスの構成に関する項を参照してください。

テスト済

REST APIを使用してKSSキーストアを管理する手順:

1. 次の手順を実行して、KSSキーストアを作成します。

a. 作成するKSSキーストアを定義するJSONドキュメント(createkss.json)を作成します。
リクエスト・ドキュメントの例を次に示します。この例では、KSSストライプおよびキーストアの名前はmyStripeおよびmyKeystore、KSSキーストアのパスワードはmypwd、作成されるKSSキーストアは権限ベースではありません。

{
"stripe" : "myStripe",
"keystore" : "myKeystore",
"pwd" : "mypwd",
"permission" : "false"
}

リクエストの属性の詳細は、「新しいKSSキーストアのPOSTメソッド」を参照してください。

b. cURLを使用して、前のステップで定義したJSONドキュメントを渡してKSSキーストアを作成します。

curl -i -X POST -u username:password -H Content-Type:application/json --data @createkss.json http://myhost:7001/idaas/platform/admin/v1/keystoreservice

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS": "Succeeded"
}

詳細は、「新しいKSSキーストアのPOSTメソッド」を参照してください。

2. ストライプのすべてのKSSキーストアを参照して、KSSキーストアが作成されたことを確認します。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystoreservice/myStripe

次は、ストライプのすべてのKSSキーストアを示しているレスポンスの例です。

{
"keystore 1:"myKeystore"
}

詳細は、「ストライプのKSSキーストアのGETメソッド」を参照してください。

3. 次の手順を実行して、KSSキーストアに信頼できる証明書をインポートします。

a. KSSキーストアにインポートする信頼できる証明書の詳細を定義するJSONドキュメント(importkss.json)を作成します。
リクエスト・ドキュメントの例を次に示します。この例では、KSSキーストアはストライプ名とキーストア名(myStripeとmyKeystore)で識別され、KSSキーストアのパスワード(mypwd)は必須であり、キーの別名はmyAliasです。証明書はTrustedCertificateとして定義され、keystoreEntryは暗号化された証明書の内容を指定します。

{
"keyAlias" : "myAlias",
"keystoreEntry":
"MIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAwSDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECxMBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYTAXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBAMTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/gLZRJmlFXUAiUftZPY1Y+r/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQIsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu/yIgMZndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX2g3GotHd7Kht/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9bhSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBBYEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH/G1ixrEaWAG3lGWafkHgXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c=",
"keystoreEntryType" : "TrustedCertificate",
"keystoreName" : "myKeystore",
"stripeName" : "myStripe",
"keystorePassword" : "myPwd"
}

リクエストの属性の詳細は、「KSSキーストアの信頼できる証明書のPOSTメソッド」を参照してください。

b. cURLを使用して、前のステップで定義したJSONドキュメントを渡してKSSキーストアに信頼できる証明書をインポートします。

curl -i -X POST -u username:password -H Content-Type:application/json --data @importcertkss.json http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS": "Succeeded"
"SUBJECT_DN": "CN=y,OU=y,O=y,L=y,ST=y,C=y"
}

詳細は、「KSSキーストアの信頼できる証明書POSTメソッド」を参照してください。

4. KSSキーストアにインポートされた信頼できる証明書を参照します。

curl -i -X GET -u username:password -H keystorePassword:cHdkMQ== http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myAlias&keystoreEntryType=TrustedCertificate"

参照する信頼できる証明書に関連付けられたストライプ名、キーストアの名前とエントリ・タイプ、および別名を定義するために問合せパラメータを渡す必要があります。

次に信頼できる証明書の詳細が示されたレスポンスの例を示します。

{
"SUBJECT_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
"ISSUER_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
"NOT_BEFORE":"Fri Jul 25 02:45:11 PDT 2014",
"NOT_AFTER":"Thu Oct 23 02:45:11 PDT 2014",
"SERIAL_NO":"982191050",
"SIGNING_ALGORITHM":"1.2.840.10040.4.3",
"CONTENT":"-----BEGIN CERTIFICATE----- \nMIIC7DCCAqqgAwIBAgIEOosLyjALBgcqhkjOOAQDBQAwS
EKMAgGA1UEBhMBcjEKMAgGA1UECBMB\ncjEKMAgGA1UEBxMBcjEKMAgGA1UEChMBcjEKMAgGA1UECxM
cjEKMAgGA1UEAxMBUjAeFw0xNDA3\nMjUwOTQ1MTFaFw0xNDEwMjMwOTQ1MTFaMEgxCjAIBgNVBAYTA
IxCjAIBgNVBAgTAXIxCjAIBgNV\nBAcTAXIxCjAIBgNVBAoTAXIxCjAIBgNVBAsTAXIxCjAIBgNVBAM
AVIwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA\/X9TgR11EilS30qcLuzk5\/YRt1I870QAwx4\/gL
RJmlFXUAiUftZPY1Y+r\/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5\/oBHsQIsJPu6nX\/rfGG
/g7V+fGqKYVDwT7g\/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu\/yIgMZndFIAccCFQCXYFCPFSMLzLKS
YKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu\/o66oL5V0wLPQeCZ1FZV4661FlP5nEHE
GAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFG
iaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7\/s9JKgOBhAACgYAjhpZybXj6rlXDow8srnSFE9dZJJpCKaQV
ACagQogePV+xlqPClDOoiQJ\nuvuUGHerDrThC1\/Wq5Uj1+TnkSKTy0qYxmQoq56xALa47np9TKtqt
4Vy8eUUorakG4lrjNt\/EgR\nfO675n+qINkKXKpcxaCicupRCYPkPXlnT4mtyKMhMB8wHQYDVR0OBB
EFDKbmPa2Il6SylJRPTv8\nQ+4CqpEhMAsGByqGSM44BAMFAAMvADAsAhQbkmlaUG5QDR5mXUiYC74p
\/FBOwIUGx5lc5Y01ppo\nvK3UgL7M8E3eOfc=\n-----END CERTIFICATE-----",
"SIGNATURE":FEZN2l4SPFEK5jt2QZRb5Q==",
"Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

詳細は、「KSSキーストアの信頼できる証明書のGETメソッド」を参照してください。

5. KSSキーストアを削除します。

curl -i -X DELETE -u username:password -H keystorePassword:cHdkMQ== http://myhost:7001/idaas/platform/admin/v1/keystoreservice?"stripeName=myStripe&keystoreName=myKeystore"

削除するKSSキーストアのストライプおよびキーストア名を定義するために問合せパラメータを渡す必要があります。詳細は、「キーストア・サービスKSSキーストアのDELETEメソッド」を参照してください。

次にリクエストの成功を示すレスポンスの例を示します。

HTTP/1.1 204 No Content

2.4 REST APIによるトークン発行者の信頼の管理

REST APIを使用して、トークン発行者の信頼を参照および管理できます。

次の方法を使用事例で示します。

- すべての信頼できる発行者の参照

- 信頼できる発行者の作成

- トークン属性ルールの作成

- 信頼できる発行者の削除

- 信頼ドキュメントの作成

注意:

トークン発行者の信頼の管理の詳細は、『Webサービスの管理』の署名証明書の信頼できる発行者および信頼できるDNリストの定義に関する項を参照してください。

REST APIを使用してトークン発行者の信頼を管理する手順:

1. 信頼できる発行者ドキュメントを作成します。

curl -i -X POST -u username:password http://myhost:7001/idaas/webservice/admin/v1/trustdocument?"documentName=myTrustDocument&displayName=myTrustDocument"

信頼できる発行者ドキュメントのドキュメント名および表示名を定義するために問合せパラメータを渡す必要があります。

次にリクエストの成功を示すレスポンスの例を示します。

{
"STATUS": "Succeeded",
"Result": "New Token Issuer Trust document named "myTrustDocument" created."
}

詳細は、「信頼ドキュメント名のPOSTメソッド」を参照してください。

2. 次の手順を実行して、信頼できる発行者およびDNリストを作成します。

a. 作成する信頼できる発行者および識別名(DN)リストを定義するJSONドキュメント(createtrust.json)を作成します。
リクエスト・ドキュメントの例を次に示します。この例では、タイプがSAML holder-of-key、SAML送信者保証およびJSON Webトークン(JWT)の信頼できる発行者を作成します。信頼できる発行者ごとに名前とDNリストを定義します。

{
"saml-trusted-dns":
{
"saml-hok-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls1", ]
}
]
},
"saml-sv-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls2", ]
}
]
},
"jwt-trusted-issuers":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "CN=orakey, OU=Orakey,O=Oracle, C=US", ]
}
]
}
}
}

リクエストの属性の詳細は、「ドメインの信頼できる発行者と識別名リストのPOSTメソッド」を参照してください。

b. cURLを使用して、ステップ2で定義したJSONドキュメントを渡して信頼できる発行者およびDNリストを作成します。

curl -i -X POST -u username:password --data @createtrust.json -H Content-Type:application/json http://myhost:7001/idaas/webservice/admin/v1/trust/issuers

次にリクエストの成功を示すレスポンス本文の例を示します。

{
"STATUS": "Succeeded"
}

詳細は、「ドメインの信頼できる発行者と識別名リストのPOSTメソッド」を参照してください。

3. 信頼できるDNリストのトークン属性ルールを定義するJSONドキュメント(createtoken.json)を作成します。
リクエスト・ドキュメントの例を次に示します。この例では、次のようにします。

- トークン属性ルールが作成される信頼できるDNリストごとに、別々の"token-attribute-rule"エントリを作成する。

- 必要に応じて、name-idおよびユーザー属性のフィルタを指定する。

リクエストの属性の詳細は、「トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)」を参照してください。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "cn=orcladmin,o=oracle",
"name-id":{
"filter":
{
"value":[ "filter1" ]
},
"mapping":
{
"user-attribute": "val3",
"user-mapping-attribute":"val4"
}
},
"attributes":
[
{
"-name": "tenant1",
"attribute":
{
"filter":
{
"value": [
"filter1",
"filter2"
]
},
"mapping":{
"user-attribute": "val1",
"user-mapping-attribute":"val2"
}
}
}
]
}
]
}
}

4. ステップ4で定義したJSONドキュメントを渡して、信頼できるDNリストのトークン属性ルールを作成します。

curl -i -X POST -u username:password --data @createrule.json http://myhost:7001/idaas/webservice/admin/v1/trust/token

次にリクエストの成功を示すレスポンス本文の例を示します。

{
"STATUS": "Succeeded"
}

詳細は、「トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)」を参照してください。

5. 信頼できる発行者の構成の詳細を参照します。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/trustdocument?"documentName=myTrustDocument"

次に構成の詳細を示すレスポンス本文の例を示します。

{
"STATUS":"Succeeded",
"Result":"List of token issuer trust documents in the Repository:\nDetails of the document matching your request:\nName         : myTrustDocument\tDisplay Name : myTrustDocument\tStatus       : DOCUMENT_STATUS_COMMITED \nList of trusted issuers for this type:\tNone\nList of Token Attribute Rules\tNone"
}

詳細は、「信頼ドキュメントのGETメソッド」を参照してください。

6. 信頼できる発行者ドキュメントを削除します。

curl -i -X DELETE -u username:password http://myhost:7001/idaas/webservice/admin/v1/trustdocument?"documentName=myTrustDocument&displayName=myTrustDocument"

削除する信頼できる発行者ドキュメントのドキュメント名および表示名を定義するために問合せパラメータを渡す必要があります。詳細は、「資格証明のDELETEメソッド」を参照してください。

次の例では、レスポンス本文のコンテンツを示しています。

{
"STATUS": "Succeeded",
"Result": "Token Issuer Trust document named "myTrustDocument" deleted from the repository."
}

第II部 REST APIリファレンス

資格証明およびキーストアの管理のためのOracle Fusion Middleware REST APIの詳細を再確認できます。

第II部は、次の章で構成されます。

- 資格証明ストア内の資格証明の管理

- Javaキーストアのキーストア管理

- キーストア・サービスのキーストアの参照と管理

- トークン発行者の信頼構成の管理

- REST APIのサマリー

3 資格証明ストア内の資格証明の管理

Oracle Web Services Manager (WSM)では、安全な形式で資格証明を管理するために資格証明ストア・フレームワーク(CSF)を使用しています。

REST APIを使用して資格証明ストアの参照や管理を行うには、まず、RESTリソースにアクセスする方法と、その他の重要な概念について理解しておく必要があります。「REST APIについて」を参照してください。

資格証明ストアの管理の詳細は、『Webサービスの管理』の資格証明ストアの構成に関する項を参照してください。

この章の内容は次のとおりです。

- RESTリソースを使用した資格証明ストアの参照と管理

- 資格証明のPOSTメソッド

- 資格証明のGETメソッド

- 資格証明のPUTメソッド

- 資格証明のDELETEメソッド

3.1 RESTリソースを使用した資格証明ストアの参照と管理

Representational State Transfer (REST)リソースを使用すると、資格証明キーストアの参照と管理が可能になります。

資格証明ストアは、次に説明するように、一連のRepresentational State Transfer (REST)リソースを使用して参照および管理できます。

参照先

メソッド

リソース・パス

資格証明のPOSTメソッド

POST

/idaas/platform/admin/v1/credential

資格証明のGETメソッド

GET

/idaas/platform/admin/v1/credential

資格証明のPUTメソッド

PUT

/idaas/platform/admin/v1/credential

資格証明のDELETEメソッド

DELETE

/idaas/platform/admin/v1/credential

3.2 資格証明のPOSTメソッド

このPOSTメソッドは、ドメイン資格証明ストアに新しい資格証明を作成するために使用します。

RESTリクエスト

POST /idaas/platform/admin/v1/credential

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

リクエスト本文には、作成リクエストの詳細が含まれます。

属性

説明

必須

"credential"

資格証明のパスワード。

はい

"key"

キーの名前。

はい

"map"

マップ(フォルダ)の名前。

はい

"username"

資格証明のユーザー名。

はい

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、作成操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して資格証明ストアに資格証明を作成する方法を示しています

テスト済

curl -i -X POST -u username:password --data @createcred.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/credential

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"username" : "username",
"credential" : "credential",
"key" : "mykey",
"map" : "oracle.wsm.security"
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

3.3 資格証明のGETメソッド

このGETメソッドは、ドメイン資格証明ストア内のすべての資格証明を参照するために使用します。

RESTリクエスト

GET /idaas/platform/admin/v1/credential

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、資格証明ストアのすべての証明書に関する次のような情報が含まれます。

属性

説明

"CSF_MAP_NAME"

資格証明ストア・マップ名。

"default"

デフォルトの資格証明マップのキー・リスト。

"oracle.wsm.security"

Oracle Web Services Manager (Oracle WSM)セキュリティ資格証明マップのキー・リスト。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して資格証明ストアのすべての資格証明を参照する方法を示しています。

テスト済

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/credential

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"CSF_MAP_NAME": "CSF_KEY_NAME",
"default": "systemuser",
"oracle.wsm.security": [
"sign-csf-key",
"jwt-sign-csf-key",
"owsmtest.credentials",
"basic.client.credentials",
"weblogic-csf-key",
"enc-csf-key",
"mykey",
"dummy-pwd-csf-key",
"weblogic-kerberos-csf-key",
"keystore-csf-key",
"weblogic-windowsdomain-csf-key",
"oratest-csf-key",
"csr-csf-key",
"invalid-csf-key",
"ca-signed-sign-csf-key"
]
}

3.4 資格証明のPUTメソッド

このPUTメソッドは、ドメイン資格証明ストア内の資格証明を更新するために使用します。

RESTリクエスト

PUT /idaas/platform/admin/v1/credential

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、更新リクエストの詳細が含まれます。

属性

説明

必須

"credential"

キーストア内のキーの更新後のパスワード。

はい

"key"

変更するキーの名前。キーが存在する必要があります。

はい

"map"

変更するマップ(フォルダ)の名前。

はい

"username"

キーストア内のキーのユーザー名。

はい

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、更新操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して資格証明ストアの資格証明を更新する方法を示しています。

テスト済

curl -i -X PUT -u username:password --data @updatecred.json -H Content-Type:application/json http://myhost:7001/idaas/patform/admin/v1/credential

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"username" : "username",
"credential" : "myNewPwd",
"key" : "mykey",
"map" : "oracle.wsm.security"
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

3.5 資格証明のDELETEメソッド

このDeleteメソッドは、ドメイン資格証明ストアから資格証明を削除するために使用します。

RESTリクエスト

DELETE /idaas/platform/admin/v1/credential

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前

説明

タイプ

"key"

削除する資格証明のキーの名前。

問合せ

"map"

削除する資格証明のマップ(フォルダ)の名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行して資格証明ストアから資格証明を削除する方法を示しています。

テスト済

curl -i -X DELETE -u username:password http://myhost:7001/idaas/platform/admin/v1/credential?"key=mykey&map=oracle.wsm.security"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

4 Javaキーストアのキーストア管理

REST APIを使用してドメイン内でJavaキーストア(JKS)のキーストアの参照や管理を行うには、まず、RESTリソースにアクセスする方法と、その他の重要な概念について理解しておく必要があります。

詳細は、「REST APIについて」を参照してください。

JKSキーストアの管理の詳細は、『Webサービスの管理』のメッセージ保護のためのキーストアの構成に関する項を参照してください。

この章の内容は次のとおりです。

- RESTリソースを使用したドメイン内のJKSキーストアの参照と管理

- JKSキーストアの信頼できる証明書のすべての別名のGETメソッド

- JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド

- JKSキーストアのPKCS#7の信頼できる証明書のPOSTメソッド

- JKSキーストアの信頼できる証明書の指定した別名のGETメソッド

- JKSキーストアの信頼できる証明書のDELETEメソッド

4.1 RESTリソースを使用したドメイン内のJKSキーストアの参照と管理

Representational State Transfer (REST)リソースを使用すると、JKSキーストアの参照と管理が可能になります。

ドメイン内のJKSキーストアの参照と管理には、Representational State Transfer (REST)リソースのセットを使用できます。次に、その概要を示します。

タスク

メソッド

リソース・パス

JKSキーストアの信頼できる証明書のすべての別名のGETメソッド

GET

/idaas/platform/admin/v1/keystore

JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド

POST

/idaas/platform/admin/v1/keystore/{alias}

JKSキーストアのPKCS#7の信頼できる証明書のPOSTメソッド

POST

/idaas/platform/admin/v1/keystore/pkcs7/{alias}

JKSキーストアの信頼できる証明書の指定した別名のGETメソッド

GET

/idaas/platform/admin/v1/keystore/{alias}

JKSキーストアの信頼できる証明書のDELETEメソッド

DELETE

/idaas/platform/admin/v1/keystore/{alias}

4.2 JKSキーストアの信頼できる証明書のすべての別名のGETメソッド

このGETメソッドは、JKSキーストアに含まれる信頼できる証明書のエントリに対応するすべての別名を取得するために使用します。

RESTリクエスト

GET /idaas/platform/admin/v1/keystore

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、別名のリストが含まれます。

属性

説明

"aliases"

別名のカンマ区切りのリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行してJKSキーストアの信頼できる証明書エントリのすべての別名を参照する方法を示しています。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystore

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

テスト済

{
"aliases":"oratest,orakey,testkey,jkstest,ms-oauthkey"
}

4.3 JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド

このPOSTメソッドは、指定した別名で信頼できる証明書をJKSキーストアにインポートするために使用します。証明書はBase64でエンコードされている必要があります。

RESTリクエスト

POST /idaas/platform/admin/v1/keystore/{alias}

パラメータ

次の表は、POSTリクエストのパラメータの概要を示します。

名前

説明

タイプ

alias

インポートする信頼できる証明書の別名。

別名は作成されます。JKSキーストアにすでに存在する別名を使用することはできません。そうでない場合、リクエストは失敗します。

パス

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、インポート・リクエストの詳細が含まれます。

属性

説明

"certificate"

Base64でエンコードされた証明書。

"component"

証明書のインポート先コンポーネント。この値はJKSに設定する必要があります。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

"SUBJECT_DN"

インポートされたサブジェクトDNのリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してJKSキーストアに信頼できる証明書をインポートする方法を示しています。

テスト済

curl -i -X POST -u username:password --data @importjkscert.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/keystore/mytestkey

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{   "component":"JKS",
"certificate": "MIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAwSDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECxMBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYTAXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBAMTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/gLZRJmlFXUAiUftZPY1Y+r/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQIsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu/yIgMZndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX2g3GotHd7Kht/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9bhSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBBYEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH/G1ixrEaWAG3lGWafkHgXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c="
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded",
"SUBJECT_DN": "CN=y,OU=y,O=y,L=y,ST=y,C=y"
}

4.4 JKSキーストアのPKCS#7の信頼できる証明書のPOSTメソッド

このPOSTメソッドは、指定した別名で示される秘密鍵に関連付けられたPKCS#7の信頼できる証明書または証明書チェーンをJKSキーストアにインポートするために使用します。

RESTリクエスト

POST /idaas/platform/admin/v1/keystore/pkcs7/{alias}

パラメータ

次の表は、POSTリクエストのパラメータの概要を示します。

名前

説明

タイプ

alias

インポートする信頼できるPKCS#7証明書の秘密鍵の別名。別名は、JKSキーストアにすでに存在する必要があります。

パス

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、インポート・リクエストの詳細が含まれます。

属性

説明

"certificate"

Base64でエンコードされた証明書。

"component"

証明書のインポート先コンポーネント。この値はJKSに設定する必要があります。

"keyPassword"

秘密鍵のパスワード。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

"SUBJECT_DN"

インポートされたサブジェクトDNのリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してJKSキーストアに信頼できるPKCS#7証明書をインポートする方法を示しています。

curl -i -X POST -u username:password --data @importjkscert.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/keystore/pkcs7/myprivatekey

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"component":"JKS",
"certificate": "MIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAwSDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECxMBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYTAXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBAMTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/gLZRJmlFXUAiUftZPY1Y+r/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQIsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu/yIgMZndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX2g3GotHd7Kht/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9bhSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBBYEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH/G1ixrEaWAG3lGWafkHgXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c=",
"keyPassword" : "myprivatekeypwd"
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded",
"SUBJECT_DN": "CN=y,OU=y,O=y,L=y,ST=y,C=y"
}

4.5 JKSキーストアの信頼できる証明書の指定した別名のGETメソッド

このGETメソッドは、指定した別名でJKSキーストア内の信頼できる証明書の詳細を参照するために使用します。

別名がkeyStore.TrustedCertificateEntryの場合、信頼できる証明書の詳細が返されます。別名がKeyStore.PrivateKeyEntryの場合、信頼できる証明書チェーンの最初の証明書が返されます。

RESTリクエスト

GET /idaas/platform/admin/v1/keystore/{alias}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

alias

参照する信頼できる証明書の別名。

パス

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性

説明

"CONTENT"

Base64でエンコードされた証明書の内容。

"Extensions"

特定目的の証明書の発行に使用されるオプションの拡張機能。拡張には次が含まれます。

- 一意に識別するオブジェクト識別子(oid)

- 拡張がクリティカルかどうかを示すフラグ

- 値

"ISSUER_DN"

信頼できる識別名のリスト。

"NOT_AFTER"

証明書が期限切れになる日付。

"NOT_BEFORE"

証明書が有効になる日付。

"SERIAL_NO"

JKSキーストアのシリアル番号。

"SIGNATURE"

Base64でエンコードされた署名キー。

"SIGNING_ALGORITHM"

別名の署名アルゴリズム。

"SUBJECT_DN"

サブジェクト識別名のリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、JKSキーストア内の別名のすべての証明書を参照する方法を示しています。

テスト済

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystore/mytestkey

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"SUBJECT_DN":"CN=weblogic,OU=Testkey for JKS Mbean test,O=Oracle,L=testcity,ST=teststate,C=us",
"ISSUER_DN":"CN=weblogic,OU=Testkey for JKS Mbean test,O=Oracle,L=testcity,ST=teststate,C=us",
"NOT_BEFORE":"Tue Jun 25 02:20:38 PDT 2013",
"NOT_AFTER":"Wed Nov 27 01:20:38 PST 2052",
"SERIAL_NO":"1372152038",
"SIGNING_ALGORITHM":"1.2.840.113549.1.1.5",
"CONTENT":"-----BEGIN CERTIFICATE-----\nMIIDeDCCAmCgAwIBAgIEUclg5jANBgkqhkiG9w0BAQUFADB9MQswCQYDVQQGEwJ1czESMBAGA1UE\nCBMJdGVzdHN0YXRlMREwDwYDVQQHEwh0ZXN0Y2l0eTEPMA0GA1UEChMGT3JhY2xlMSMwIQYDVQQL\nExpUZXN0a2V5IGZvciBKS1MgTWJlYW4gdGVzdDERMA8GA1UEAxMId2VibG9naWMwIBcNMTMwNjI1\nMDkyMDM4WhgPMjA1MjExMjcwOTIwMzhaMH0xCzAJBgNVBAYTAnVzMRIwEAYDVQQIEwl0ZXN0c3Rh\ndGUxETAPBgNVBAcTCHRlc3RjaXR5MQ8wDQYDVQQKEwZPcmFjbGUxIzAhBgNVBAsTGlRlc3RrZXkg\nZm9yIEpLUyBNYmVhbiB0ZXN0MREwDwYDVQQDEwh3ZWJsb2dpYzCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAJtmzlqcnU+9d4OIor0FIOfcgpI\/EOflbkTicUjPr1AefYl8EDnl+U7hlDQ+\nPzrsndjAtFbcmxghGuw+P7\/ztIXBBqIViLFW7wEBMdnGcO6Oc9swDca5vIofwNtor2hGI\/mIUPNx\nd9ExE2JOuqJmgr5RPyThv6mmxrVUWJGCuHg4leQvSOOXxZFRWKHHWFv8lWwaqdY3haYHVD2DlNwS\nEPWqVAPZD6Kcv58l9ucHxAER5n5+wJPHH7kkGJL2gv2LIUMhwy3rlv2Fbhy7\/MTCeXYkUno5CXH9\n+nnAdWZ\/MzuVxXdzEZv72kmW\/oHnXjSZtEdAwdQJAETz9Cxqwt9VtzsCAwEAATANBgkqhkiG9w0B\nAQUFAAOCAQEAG2\/kH7IlgFw3MAekgloOgwLgl87OVtlAySORxg2YNw9Z4GYQ2bRIL5lxp4kbMYic\nhB1SjR7aPXV0Jufw8EkBZMwDbLf053d6oPEGWF7e6roCcHlY\/mBFd7BQFHW0vlBAZN9e1HkavWNE\n4k3qmjgct5BegMi9jhGrSws5aZ33qyrWcr8zlZ3dhu52z4uGRG0UVeRnBemdPIk++6obiRErU3+v\nlI\/JYsQJmDrQwZlWGjznkXnQw5toJQuWFdoE2TUPF1r3KTZiJ+TyVh64wtbnUVptxr1lFjtSfqPq\n0nzVlZlyXTi\/Rv7X+ODkRp29Hozs95c9HA93vnCYRaneNin7Kw==\n-----END CERTIFICATE-----",
"SIGNATURE":"eAnH79sc8iMkLZRKWzh4vQ==",
"Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

4.6 JKSキーストアの信頼できる証明書のDELETEメソッド

このDeleteメソッドは、指定した別名を持つ信頼できる証明書(keyStore.TrustedCertificateEntry)をJKSキーストアから削除するために使用します。keyStore.PrivateKeyEntryは削除できません。

RESTリクエスト

DELETE /idaas/platform/admin/v1/keystore/{alias}

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前

説明

タイプ

alias

削除する信頼できる証明書エントリの別名。

パス

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。

テスト済

curl -i -X DELETE -u username:password http://myhost:7001/idaas/platform/admin/v1/keystore/testalias

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

5 キーストア・サービスのキーストアの参照と管理

REST APIを使用してキーストア・サービス(KSS)キーストアを参照および管理するには、まず、RESTリソースにアクセスする方法と、その他の重要な概念について理解しておく必要があります。

「REST APIについて」を参照してください。

KSSキーストアの管理の詳細は、『Webサービスの管理』のメッセージ保護のためのOPSSキーストア・サービスの構成に関する項を参照してください。

この章の内容は次のとおりです。

- RESTリソースを使用したKSSキーストアの参照と管理

- 新しいKSSキーストアのPOSTメソッド

- KSSキーストアをインポートするPOSTメソッド

- KSSキーストアのパスワードを更新するPUTメソッド

- KSSキーストアの信頼できる証明書のPOSTメソッド

- ストライプのKSSキーストアのGETメソッド

- KSSキーストアの別名のGETメソッド

- KSSキーストアの信頼できる証明書のGETメソッド

- KSSキーストアの信頼できる証明書のDELETEメソッド

- KSSキーストアの秘密鍵プロパティのPOSTメソッド

- KSSキーストアの秘密鍵プロパティのGETメソッド

- キーストア・サービスKSSキーストアのDELETEメソッド

5.1 RESTリソースを使用したKSSキーストアの参照と管理

KSSキーストアの参照と管理には、Representational State Transfer (REST)リソースのセットを使用できます。次に、その概要を示します。

参照先

メソッド

リソース・パス

新しいKSSキーストアのPOSTメソッド

POST

/idaas/platform/admin/v1/keystoreservice

KSSキーストアをインポートするPOSTメソッド

POST

/idaas/platform/admin/v1/keystoreservice/keystore

KSSキーストアのパスワードを更新するPUTメソッド

PUT

/idaas/platform/admin/v1/keystoreservice

KSSキーストアの信頼できる証明書のPOSTメソッド

POST

/idaas/platform/admin/v1/keystoreservice/certificates

ストライプのKSSキーストアのGETメソッド

GET

/idaas/platform/admin/v1/keystoreservice/{stripeName}

KSSキーストアの別名のGETメソッド

GET

/idaas/platform/admin/v1/keystoreservice/alias/{stripeName}/{keystoreName}/{entryType}

KSSキーストアの信頼できる証明書のGETメソッド

GET

/idaas/platform/admin/v1/keystoreservice/certificates

KSSキーストアの信頼できる証明書のDELETEメソッド

DELETE

/idaas/platform/admin/v1/keystoreservice/certificates

KSSキーストアの秘密鍵プロパティのPOSTメソッド

POST

/idaas/platform/admin/v1/keystoreservice/secretkey

KSSキーストアの秘密鍵プロパティのGETメソッド

GET

/idaas/platform/admin/v1/keystoreservice/secretkey

キーストア・サービスKSSキーストアのDELETEメソッド

DELETE

/idaas/platform/admin/v1/keystoreservice

5.2 新しいKSSキーストアのPOSTメソッド

このPOSTメソッドは、新しいキーストア・サービス(KSS)キーストアを作成するために使用します。

RESTリクエスト

POST /idaas/platform/admin/v1/keystoreservice

リクエスト本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

リクエスト本文には、作成リクエストの詳細が含まれます。

属性

説明

"keystore"

KSSキーストアの名前。

"permission"

権限ベースのキーストアを作成するかどうかを指定するブール値。

"pwd"

KSSキーストアのパスワード。

"stripe"

KSSキーストアを含めるストライプの名前。

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、作成操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアを作成する方法を示しています。

テスト済

curl -i -X POST -u username:password --data @createkss.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/keystoreservice

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"stripe" : "myStripe",
"keystore" : "myKeystore",
"pwd" : "myPwd",
"permission" : "false"
}

注意:

パスワードは必須です。ただし、権限ベースのキーストア("permission" : "true")を作成する場合を除きます。

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 201 Created

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

5.3 KSSキーストアをインポートするPOSTメソッド

このPOSTメソッドは、JKSキーストア・ファイルからキーストア・サービス(KSS)キーストアをインポートするために使用します。

RESTリクエスト

POST /idaas/platform/admin/v1/keystoreservice/keystore

リクエスト本文

リクエスト本文のメディア・タイプ: multipart/form-data

レスポンス本文には、インポート・リクエストに関する次のような情報が含まれます。

属性

説明

"keyAliases"

keystoreFileからインポートするキーの別名のカンマ区切りのリスト。

"keyPasswords"

keystoreFileからインポートするキーのパスワードのカンマ区切りのリスト。

"keystoreFile"

有効なローカルJKSキーストアのファイル名。

"keystoreName"

JKSキーストアの名前。

"keystorePassword"

パスワードで保護されている場合、インポートするローカル・キーストア・ファイルのパスワードおよびキーストア・エントリ。

"keystoreType"

キーストアのタイプ。この値はJKSに設定する必要があります。

"permission"

権限ベースのキーストアとしてインポートするかどうかを指定するブール値。

"stripeName"

ストライプの名前。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

レスポンス本文には、インポート操作に関する次のような情報が含まれます。

属性

説明

"alias n"

ストライプ内のキーストアのリスト。ここで、nは1から開始し、追加のキーストアごとに1ずつ増加するインデックスとなります。

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアをインポートする方法を示しています。

テスト済

curl -i -X POST -u username:password -H Content-Type:multipart/form-data --form "stripeName=myStripe" --form "keystoreFile=@clientkeystore" --form "keystoreName=myKeystore" --form "keystorePassword=myPwd" --form "keystoreType=JKS" --form "keyAliases=client" --form "keyPasswords=myPwd2" --form "permission=false" http://myhost:7001/idaas/platform/admin/v1/keystoreservice/keystore

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 201 Created

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS":"Succeeded",
"SUCCESS_MSG":"Aliases:client imported successfully",
"alias 1":"client"
}

5.4 KSSキーストアのパスワードを更新するPUTメソッド

このPUTメソッドは、キーストア・サービス(KSS)キーストアのパスワードを更新するために使用します。

RESTリクエスト

PUT /idaas/platform/admin/v1/keystoreservice

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

レスポンス本文には、ロード・バランサのパッチに関する次のような情報が含まれます。

属性

説明

"keystore"

KSSキーストアの名前。

"newpass"

キーストアの新しいパスワード。

"oldpass"

キーストアの旧パスワード。

"stripe"

ストライプの名前。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、更新操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行してKSSキーストアをインポートする方法を示しています。

テスト済

curl -i -X PUT -u username:password --data @updatekss.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/keystoreservice

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"stripe" : "myStripe",
"keystore" : "mykssstore",
"oldpass" : "myPwd",
"newpass" : "myNewPwd"
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

5.5 KSSキーストアの信頼できる証明書のPOSTメソッド

このPOSTメソッドは、キーストア・サービス(KSS)キーストアに信頼できる証明書をインポートするために使用します。

RESTリクエスト

POST /idaas/platform/admin/v1/keystoreservice/certificates

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

レスポンス本文には、インポート・リクエストに関する次のような情報が含まれます。

属性

説明

"keyAlias"

信頼できる証明書の別名。

"keystoreEntry"

Base64でエンコードされた証明書。

"keystoreEntryType"

キーストア・エントリのタイプ。有効な値には、Certificate、TrustedCertificateまたはSecretKeyがあります。

"keystoreName"

KSSキーストアの名前。

"keystorePassword"

KSSキーストアのパスワード。

"stripeName"

ストライプの名前。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

"SUBJECT_DN"

インポートされたサブジェクトDNのリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアを作成する方法を示しています。

テスト済

curl -i -X POST -u username:password --data @importcertkss.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"keyAlias" : "myAlias",
"keystoreEntry":
"MIIC7DCCAqqgAwIBAgIEalhBSjALBgcqhkjOOAQDBQAwSDEKMAgGA1UEBhMBeTEKMAgGA1UECBMB\neTEKMAgGA1UEBxMBeTEKMAgGA1UEChMBeTEKMAgGA1UECxMBeTEKMAgGA1UEAxMBeTAeFw0xNDA3\nMDMxMTAwMTZaFw0xNDEwMDExMTAwMTZaMEgxCjAIBgNVBAYTAXkxCjAIBgNVBAgTAXkxCjAIBgNV\nBAcTAXkxCjAIBgNVBAoTAXkxCjAIBgNVBAsTAXkxCjAIBgNVBAMTAXkwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/gLZRJmlFXUAiUftZPY1Y+r/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQIsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu/yIgMZndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7/s9JKgOBhAACgYBrvzkjozmv6t6T0GNJES1R3ypRsBs8VLX2g3GotHd7Kht/TCj4HikelZDd\nuL0t96R5Q4A3srOgSIZ+0INRs1ER8y1Q37LyJNfyqYn5KqLBlN9bhSYAfcuIpjwIXGVfLQGdByD7\ntr4PSvZQx18K6p68HUCh+jXQT9+7n3ZUIBzH5aMhMB8wHQYDVR0OBBYEFPdMpcEBbYSCYMdJiE4r\ncQxf7Me4MAsGByqGSM44BAMFAAMvADAsAhQH/G1ixrEaWAG3lGWafkHgXxnzhwIUW5eSctgmaQBj\nvKaY0E6fYJzcp5c=",
"keystoreEntryType" : "TrustedCertificate",
"keystoreName" : "myKeystore",
"stripeName" : "myStripe",
"keystorePassword" : "myPwd"
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
"SUBJECT_DN": "CN=y,OU=y,O=y,L=y,ST=y,C=y"
}

5.6 ストライプのKSSキーストアのGETメソッド

このGETメソッドは、ストライプのすべてのキーストア・サービス(KSS)キーストアを返すために使用します。

RESTリクエスト

GET /idaas/platform/admin/v1/keystoreservice/{stripeName}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

stripeName

すべてのKSSキーストアを参照するストライプの名前。

パス

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性

説明

"keystore n"

ストライプ内のキーストアのリスト。ここで、nは1から開始し、追加のキーストアごとに1ずつ増加するインデックスとなります。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

テスト済

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystoreservice/myStripe

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"keystore 1":"trust",
"keystore 2":"castore"
}

5.7 KSSキーストアの別名のGETメソッド

このGETメソッドは、キーストア・サービス(KSS)キーストアの別名を参照するために使用します。

RESTリクエスト

GET /idaas/platform/admin/v1/keystoreservice/alias/{stripeName}/{keystoreName}/{entryType}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

entryType

キーストアのタイプ。有効な値には、Certificate、TrustedCertificateまたはSecretKeyがあります。

パス

keystoreName

キーストアの名前。

パス

stripeName

ストライプの名前。

パス

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性

説明

"keystore n"

ストライプ内のキーストアの別名のリスト。ここで、nは1から開始し、追加のプロパティごとに1ずつ増加するインデックスとなります。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

テスト済

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/keystoreservice/alias/myStripe/myKeystore/TrustedCertificate

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"keystore 1":"myAlias",
}

5.8 KSSキーストアの信頼できる証明書のGETメソッド

このGETメソッドは、キーストア・サービス(KSS)内の信頼できる証明書を参照するために使用します。キーストアがパスワードで保護されている場合は、キーストアのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

GET /idaas/platform/admin/v1/keystoreservice/certificates

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

keyAlias

信頼できる証明書の別名。

問合せ

keystoreEntryType

キーストア・エントリのタイプ。有効な値には、Certificate、TrustedCertificateまたはCertificateChainがあります。

問合せ

keystoreName

キーストアの名前。

問合せ

stripeName

ストライプの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性

説明

"CONTENT"

Base64でエンコードされた証明書の内容。

"Extensions"

特定目的の証明書の発行に使用されるオプションの拡張機能。拡張には次が含まれます。

- 一意に識別するオブジェクト識別子(oid)

- 拡張がクリティカルかどうかを示すフラグ

- 値のセット

"ISSUER_DN"

信頼できる識別名のリスト。

"NOT_AFTER"

証明書が期限切れになる日付。

"NOT_BEFORE"

証明書が有効になる日付。

"SERIAL_NO"

JKSキーストアのシリアル番号。

"SIGNATURE"

Base64でエンコードされた署名キー。

"SIGNING_ALGORITHM"

別名の署名アルゴリズム。

"SUBJECT_DN"

サブジェクト識別名のリスト。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

テスト済

curl -i -X GET -u username:password -H keystorePassword:cHdkMQ== http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=client&keystoreEntryType=Certificate"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"SUBJECT_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
"ISSUER_DN":"CN=y,OU=y,O=y,L=y,ST=y,C=y",
"NOT_BEFORE":"Fri Jul 25 02:45:11 PDT 2014",
"NOT_AFTER":"Thu Oct 23 02:45:11 PDT 2014",
"SERIAL_NO":"982191050",
"SIGNING_ALGORITHM":"1.2.840.10040.4.3",
"CONTENT":"-----BEGIN CERTIFICATE----- \nMIIC7DCCAqqgAwIBAgIEOosLyjALBgcqhkjOOAQDBQAwS
EKMAgGA1UEBhMBcjEKMAgGA1UECBMB\ncjEKMAgGA1UEBxMBcjEKMAgGA1UEChMBcjEKMAgGA1UECxM
cjEKMAgGA1UEAxMBUjAeFw0xNDA3\nMjUwOTQ1MTFaFw0xNDEwMjMwOTQ1MTFaMEgxCjAIBgNVBAYTA
IxCjAIBgNVBAgTAXIxCjAIBgNV\nBAcTAXIxCjAIBgNVBAoTAXIxCjAIBgNVBAsTAXIxCjAIBgNVBAM
AVIwggG3MIIBLAYHKoZIzjgE\nATCCAR8CgYEA\/X9TgR11EilS30qcLuzk5\/YRt1I870QAwx4\/gL
RJmlFXUAiUftZPY1Y+r\/F9bow\n9subVWzXgTuAHTRv8mZgt2uZUKWkn5\/oBHsQIsJPu6nX\/rfGG
/g7V+fGqKYVDwT7g\/bTxR7DAjVU\nE1oWkTL2dfOuK2HXKu\/yIgMZndFIAccCFQCXYFCPFSMLzLKS
YKi64QL8Fgc9QKBgQD34aCF1ps9\n3su8q1w2uFe5eZSvu\/o66oL5V0wLPQeCZ1FZV4661FlP5nEHE
GAtEkWcSPoTCgWE7fPCTKMyKbh\nPBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFG
iaiD3+Fa5Z8GkotmXoB7VSVk\nAUw7\/s9JKgOBhAACgYAjhpZybXj6rlXDow8srnSFE9dZJJpCKaQV
ACagQogePV+xlqPClDOoiQJ\nuvuUGHerDrThC1\/Wq5Uj1+TnkSKTy0qYxmQoq56xALa47np9TKtqt
4Vy8eUUorakG4lrjNt\/EgR\nfO675n+qINkKXKpcxaCicupRCYPkPXlnT4mtyKMhMB8wHQYDVR0OBB
EFDKbmPa2Il6SylJRPTv8\nQ+4CqpEhMAsGByqGSM44BAMFAAMvADAsAhQbkmlaUG5QDR5mXUiYC74p
\/FBOwIUGx5lc5Y01ppo\nvK3UgL7M8E3eOfc=\n-----END CERTIFICATE-----",
"SIGNATURE":FEZN2l4SPFEK5jt2QZRb5Q==",
"Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

5.9 KSSキーストアの信頼できる証明書のDELETEメソッド

このDeleteメソッドは、キーストア・サービス(KSS)キーストアから証明書を削除するために使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

DELETE /idaas/platform/admin/v1/keystoreservice/certificates

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前

説明

タイプ

keyAlias

KSSキーストアの証明書の別名。

問合せ

keystoreName

キーストアの名前。

問合せ

stripeName

ストライプの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。

テスト済

curl -i -X DELETE -u username:password -H keystorePassword:cHdkMQ== -H keyPassword:bXlQd2Qy  http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myAlias"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

5.10 KSSキーストアの秘密鍵プロパティのPOSTメソッド

このPOSTメソッドは、KSSキーストアの対象型暗号化/復号化に使用する秘密鍵を作成するために使用します。

RESTリクエスト

POST /idaas/platform/admin/v1/keystoreservice/secretkey

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、作成リクエストの詳細が含まれます。

属性

説明

"algorithm"

メッセージ保護に使用される暗号アルゴリズムの特性を制御します。

"keyAlias"

秘密鍵の別名。

"keyPassword"

秘密鍵のパスワード。

"keySize"

暗号アルゴリズムで使用されるキーのサイズ(ビット単位)。

"keystoreName"

KSSキーストアの名前。

"keystorePassword"

KSSキーストアのパスワード。

"stripeName"

ストライプの名前。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して秘密鍵を作成する方法を示しています。

テスト済

curl -i -X POST -u username:password --data @secretkey.json -H Content-Type:application/json http://myhost:7001/idaas/platform/admin/v1/keystoreservice/secretkey

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"stripeName" : "myStripe",
"keystoreName" : "myKeystore",
"keyAlias" : "myKeyAlias",
"keySize" : "56",
"algorithm" : "DES",
"keystorePassword" : "myPwd",
"keyPassword" : "myKeyPwd"
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

5.11 KSSキーストアの秘密鍵プロパティのGETメソッド

このGETメソッドは、KSSキーストアの秘密鍵のプロパティを参照するために使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

GET /idaas/platform/admin/v1/keystoreservice/secretkey

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

keyAlias

秘密鍵の別名。

問合せ

keystoreName

キーストアの名前。

問合せ

stripeName

ストライプの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、証明書に関する次のような情報が含まれます。

属性

説明

"Property n"

秘密鍵のプロパティ・リスト。ここで、nは1から開始し、追加のプロパティごとに1ずつ増加するインデックスとなります。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

テスト済

curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= http://myhost:7001/idaas/platform/admin/v1/keystoreservice/secretkey?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"Property 1":"DES"
}

5.12 キーストア・サービスKSSキーストアのDELETEメソッド

このDeleteメソッドは、キーストア・サービス(KSS)キーストアを削除するために使用します。キーストアがパスワードで保護されている場合は、キーストアのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。

RESTリクエスト

DELETE /idaas/platform/admin/v1/keystoreservice

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前

説明

タイプ

keystoreName

キーストアの名前。

問合せ

stripeName

ストライプの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。

テスト済

curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q= http://myhost:7001/idaas/platform/admin/v1/keystoreservice?"stripeName=myStripe&keystoreName=myKeystore"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 204 No Content

6 トークン発行者の信頼構成の管理

REST APIを使用してトークン発行者の信頼構成の参照や管理を行うには、まず、RESTリソースにアクセスする方法と、その他の重要な概念について理解しておく必要があります。

詳細は、「REST APIについて」を参照してください。

トークン発行者の信頼の管理の詳細は、『Webサービスの管理』の署名証明書の信頼できる発行者および信頼できるDNリストの定義に関する項を参照してください。

この章の内容は次のとおりです。

- RESTリソースを使用したトークン発行者の信頼構成の参照と管理

- 信頼ドキュメント名のPOSTメソッド

- ドメインの信頼できる発行者と識別名リストのPOSTメソッド

- ドキュメントの信頼できる発行者と識別名リストのPOSTメソッド

- すべての信頼できる発行者と識別名リストのGETメソッド

- 特定のドキュメントの信頼できる発行者と識別名リストのGETメソッド

- トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)

- トークン属性ルール識別名のPOSTメソッド(ドキュメント・コンテキスト)

- すべてのトークン属性のGETメソッド

- 指定したドキュメント・トークン属性ルールのGETメソッド

- 信頼ドキュメント名の構成のインポート・メソッド

- 信頼ドキュメントのGETメソッド

- 信頼ドキュメントのDELETEメソッド

6.1 RESTリソースを使用したトークン発行者の信頼構成の参照と管理

トークン発行者の信頼構成の参照と管理には、Representational State Transfer (REST)リソースのセットを使用できます。次に、その概要を示します。

参照先

メソッド

リソース・パス

信頼ドキュメント名のPOSTメソッド

POST

/idaas/webservice/admin/v1/trustdocument

ドメインの信頼できる発行者と識別名リストのPOSTメソッド

POST

/idaas/webservice/admin/v1/trust/issuers

ドキュメントの信頼できる発行者と識別名リストのPOSTメソッド

POST

/idaas/webservice/admin/v1/trust/issuers

すべての信頼できる発行者と識別名リストのGETメソッド

GET

/idaas/webservice/admin/v1/trust/issuers

特定のドキュメントの信頼できる発行者と識別名リストのGETメソッド

GET

/idaas/webservice/admin/v1/trust/issuers

トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)

POST

/idaas/webservice/admin/v1/trust/token

トークン属性ルール識別名のPOSTメソッド(ドキュメント・コンテキスト)

POST

/idaas/webservice/admin/v1/trust/token

すべてのトークン属性のGETメソッド

GET

/idaas/webservice/admin/v1/trust/token

指定したドキュメント・トークン属性ルールのGETメソッド

GET

/idaas/webservice/admin/v1/trust/token

信頼ドキュメント名の構成のインポート・メソッド

POST

/idaas/webservice/admin/v1/trustdocument/import

信頼ドキュメントのGETメソッド

GET

/idaas/webservice/admin/v1/trustdocument

信頼ドキュメントのDELETEメソッド

DELETE

/idaas/webservice/admin/v1/trustdocument

6.2 信頼ドキュメント名のPOSTメソッド

このPostメソッドは、信頼できる発行者ドキュメントを作成するために使用します。

RESTリクエスト

POST /idaas/webservice/admin/v1/trustdocument

パラメータ

次の表は、POSTリクエストのパラメータの概要を示します。

名前

説明

タイプ

"displayName"

ドキュメントの表示名。

問合せ

"documentName"

ドキュメントの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"Result"

操作結果の詳細。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して信頼できる発行者ドキュメントを作成する方法を示しています。

curl -i -X POST -u username:password  http://myhost:7001/idaas/webservice/admin/v1/trustdocument?"documentName=myTrustDocument&displayName=myTrustDocument"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded",
"Result": "New Token Issuer Trust document named "myTrustDocument" created."
}

6.3 ドメインの信頼できる発行者と識別名リストのPOSTメソッド

このPOSTメソッドは、ドメインのコンテキストにおける署名証明書(つまり、ドメイン全体に適用される署名証明書)の信頼できる発行者と識別名(DN)のリストを作成するために使用します。

RESTリクエスト

POST /idaas/webservice/admin/v1/trust/issuers

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、追加リクエストの詳細が含まれます。

属性

説明

必須

"dn"

信頼できる発行者に追加されるDN値のリスト。各DNについて、RFC 2253に従った文字列を使用します(次のURLを参照: http://www.ietf.org/rfc/rfc2253.txt)。

はい

"issuer"

信頼できる発行者に関する情報をグループ化します。

はい

"-name"

信頼する発行者の名前。たとえば、www.yourcompany.com。事前定義のSAMLクライアント・ポリシーのデフォルト値はwww.oracle.comです。

はい

"jwt-trusted-dns"

JSON Web Token (JWT)の信頼できる発行者に関する情報をグループ化します。

いいえ

"saml-hok-trusted-dns"

SAML holder-of-keyの信頼できる発行者に関する情報をグループ化します。

いいえ

"saml-sv-trusted-dns"

SAML送信者保証の信頼できる発行者に関する情報をグループ化します。

いいえ

"saml-trusted-dns"

信頼できる発行者およびDNリストをグループ化します。

はい

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して信頼できる発行者およびDNリストを作成する方法を示しています。

curl -i -X POST -u username:password --data @createtrust.json -H Content-Type:application/json http://myhost:7001/idaas/webservice/admin/v1/trust/issuers

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"saml-trusted-dns":
{
"saml-hok-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls1", ]
}
]
},
"saml-sv-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls2", ]
}
]
},
"jwt-trusted-issuers":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "CN=orakey, OU=Orakey,O=Oracle, C=US", ]
}
]
}
}
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded",
}

6.4 ドキュメントの信頼できる発行者と識別名リストのPOSTメソッド

このPOSTメソッドは、ドキュメントのコンテキストにおける署名証明書(つまり、特定のドキュメントに適用される署名証明書)の信頼できる発行者と識別名(DN)のリストを作成するために使用します。信頼できる発行者は、指定された信頼できる発行者ドキュメントに格納されます。

RESTリクエスト

POST /idaas/webservice/admin/v1/trust/issuers/{documentName}

パラメータ

次の表は、POSTリクエストのパラメータの概要を示します。

名前

説明

タイプ

documentName

信頼できる発行者ドキュメントの名前。信頼できる発行者ドキュメントの作成の詳細は、「信頼ドキュメント名のPOSTメソッド」を参照してください。

問合せ

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、追加リクエストの詳細が含まれます。

属性

説明

必須

"dn"

信頼できる発行者に追加されるDN値のリスト。各DNについて、RFC 2253に従った文字列を使用します(次のURLを参照: http://www.ietf.org/rfc/rfc2253.txt)。

はい

"issuer"

信頼できる発行者に関する情報をグループ化します。

はい

"-name"

信頼する発行者の名前。たとえば、www.yourcompany.com。事前定義のSAMLクライアント・ポリシーのデフォルト値はwww.oracle.comです。

はい

"jwt-trusted-dns"

JSON Web Token (JWT)の信頼できる発行者に関する情報をグループ化します。

いいえ

"saml-hok-trusted-dns"

SAML holder-of-keyの信頼できる発行者に関する情報をグループ化します。

いいえ

"saml-sv-trusted-dns"

SAML送信者保証の信頼できる発行者に関する情報をグループ化します。

いいえ

"saml-trusted-dns"

信頼できる発行者およびDNリストをグループ化します。

はい

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行し、信頼できる発行者とDNリストを作成する方法を示しています

curl -i -X POST -u username:password --data @createtrust.json -H Content-Type:application/json http://myhost:7001/idaas/webservice/admin/v1/trust/issuers/mydocument

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
"saml-trusted-dns":
{
"saml-hok-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls1", ]
}
]
},
"saml-sv-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls2", ]
}
]
},
"jwt-trusted-issuers":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "CN=orakey, OU=Orakey,O=Oracle, C=US", ]
}
]
}
}
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded",
}

6.5 すべての信頼できる発行者と識別名リストのGETメソッド

このGETメソッドは、すべてのドメイン・ドキュメントについて、信頼できる発行者と発行者の識別名(DN)リストを参照するために使用します。

RESTリクエスト

GET /idaas/webservice/admin/v1/trust/issuers

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、信頼できる発行者およびDNリストに関する次のような情報が含まれます。

属性

説明

"dn"

信頼できる発行者に追加されるDN値のリスト。

"issuer"

信頼できる発行者に関する情報をグループ化します。

"-name"

信頼する発行者の名前。

"jwt-trusted-dns"

JSON Web Token (JWT)の信頼できる発行者に関する情報をグループ化します。

"saml-hok-trusted-dns"

SAML holder-of-keyの信頼できる発行者に関する情報をグループ化します。

"saml-sv-trusted-dns"

SAML送信者保証の信頼できる発行者に関する情報をグループ化します。

"saml-trusted-dns"

DNリストをグループ化します。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して信頼できる発行者およびそのDNリストを参照する方法を示しています。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/trust/issuers

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"saml-trusted-dns":
{
"saml-hok-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls1", ]
}
]
},
"saml-sv-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls2", ]
}
]
},
"jwt-trusted-issuers":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "CN=orakey, OU=Orakey,O=Oracle, C=US", ]
}
]
}
}
}

6.6 特定のドキュメントの信頼できる発行者と識別名リストのGETメソッド

このGETメソッドは、指定されたドキュメント名に基づいて、信頼できる発行者と発行者の識別名(DN)リストを参照するために使用します。

RESTリクエスト

GET /idaas/webservice/admin/v1/trust/issuers/{documentName}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

documentName

発行者とDNリストを参照するドキュメントの名前。

パス

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、信頼できる発行者およびDNリストに関する次のような情報が含まれます。

属性

説明

"dn"

信頼できる発行者に追加されるDN値のリスト。

"issuer"

信頼できる発行者に関する情報をグループ化します。

"-name"

信頼する発行者の名前。

"jwt-trusted-dns"

JSON Web Token (JWT)の信頼できる発行者に関する情報をグループ化します。

"saml-hok-trusted-dns"

SAML holder-of-keyの信頼できる発行者に関する情報をグループ化します。

"saml-sv-trusted-dns"

SAML送信者保証の信頼できる発行者に関する情報をグループ化します。

"saml-trusted-dns"

DNリストをグループ化します。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して信頼できる発行者およびそのDNリストを参照する方法を示しています。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/trust/issuers/mydocument

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"saml-trusted-dns":
{
"saml-hok-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls1", ]
}
]
},
"saml-sv-trusted-dns":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "wls2", ]
}
]
},
"jwt-trusted-issuers":
{
"issuer": [
{
"-name": "www.oracle.com",
"dn": [ "CN=orakey, OU=Orakey,O=Oracle, C=US", ]
}
]
}
}
}

6.7 トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)

このPOSTメソッドは、ドメインのコンテキストに対応する信頼できる識別名(DN)のトークン属性ルール(つまり、ドメイン全体に適用されるルール)を作成するために使用します。この操作は、RESTサービスまたはクライアントにより実行できます。クライアント側ではトークン属性のマッピングのみがサポートされます。

RESTリクエスト

POST /idaas/webservice/admin/v1/trust/token

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、追加リクエストの詳細が含まれます。

属性

説明

"attributes"

信頼できるユーザーの制約フィルタおよびマッピングの属性をグループ化します。

注意: クライアント側では、この属性は必要ではありません。

"-dn"

サービス側では、属性ルールが構成される信頼できるDNに設定します。RFC 2253に従った文字列を使用します(次のURLを参照: http://www.ietf.org/rfc/rfc2253.txt)。

クライアント側では、http(s)://hostまたはhttp(s)://host/rootの形式を使用して、この値を、対象のサービスをホストしているドメインのURLに設定します。たとえば、この値をhttps://messaging.us2.com/に設定した場合、https://messaging.us2.com/<path>の形式のサービスURLを使用したサービスの起動すべてに属性ルールが適用されます。

"filter"

信頼できるユーザーの制約値および属性を定義します。

注意: この属性は、クライアント側では適用されません。

"mapping"

信頼できるユーザーのマッピング属性を定義します。

"-name"

属性ルールの名前。

注意: この属性は、クライアント側では適用されません。

"name-id"

信頼できるDNとして受け入れるユーザーを定義します。

"token-attribute-rule"

1つのトークン属性ルールに関する情報をグループ化します。

"tokn-attribute-rules"

すべてのトークン属性ルールに関する情報をグループ化します。

"user-attribute"

信頼できるDNがアサートできるユーザー属性を定義します。

注意: この属性は、クライアント側では適用されません。

"user-mapping-attribute"

信頼できるDNがアサートできるユーザー・マッピング属性を定義します。

"value"

制約フィルタの属性値を定義します。この値には、完全な名前またはワイルドカード文字(*)を含む名前パターン(yourTrusted*など)を使用できます。複数の値は、カンマで区切る必要があります。

注意: この属性は、クライアント側では適用されません。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して信頼できるDNのトークン属性ルールを作成する方法を示しています。

curl -i -X POST -u username:password --data @createrule.json http://myhost:7001/idaas/webservice/admin/v1/trust/token

リクエスト本文の例(サービス側)

次の例は、サービス側で信頼できるDNのトークン属性ルールを作成する場合のJSON形式のリクエスト本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "cn=orcladmin,o=oracle",
"name-id":{
"filter":
{
"value":[ "filter1" ]
},
"mapping":
{
"user-attribute": "val3",
"user-mapping-attribute":"val4"
}
},
"attributes":
[
{
"-name": "tenant1",
"attribute":
{
"filter":
{
"value": [
"filter1",
"filter2"
]
},
"mapping":{
"user-attribute": "val1",
"user-mapping-attribute":"val2"
}
}
}
]
}
]
}
}

リクエスト本文の例(クライアント側)

次の例は、クライアント側でトークン属性ルールを作成する場合のJSON形式のリクエスト本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"mail"
}
},
}
]
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/mysvcInstance1-acme/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"uid"
}
},
}
]
}
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

6.8 トークン属性ルール識別名のPOSTメソッド(ドキュメント・コンテキスト)

このPOSTメソッドは、ドキュメントのコンテキストに対応する信頼できる識別名(DN)のトークン属性ルール(つまり、特定のドキュメントに適用されるルール)を作成するために使用します。この操作は、RESTサービスまたはクライアントにより実行できます。クライアント側ではトークン属性のマッピングのみがサポートされます。

RESTリクエスト

POST /idaas/webservice/admin/v1/trust/token/{documentName}

パラメータ

次の表は、POSTリクエストのパラメータの概要を示します。

名前

説明

タイプ

documentName

トークン属性ルールを作成するドキュメントの名前。

パス

リクエスト本文

リクエスト本文のメディア・タイプ: application/json

リクエスト本文には、追加リクエストの詳細が含まれます。

属性

説明

"attributes"

信頼できるユーザーの制約フィルタおよびマッピングの属性をグループ化します。

注意: クライアント側では、この属性は必要ではありません。

"-dn"

サービス側では、属性ルールが構成される信頼できるDNに設定します。RFC 2253に従った文字列を使用します(次のURLを参照: http://www.ietf.org/rfc/rfc2253.txt)。

クライアント側では、http(s)://hostまたはhttp(s)://host/rootの形式を使用して、この値を、対象のサービスをホストしているドメインのURLに設定します。たとえば、この値をhttps://messaging.us2.com/に設定した場合、https://messaging.us2.com/<path>の形式のサービスURLを使用したサービスの起動すべてに属性ルールが適用されます。

"filter"

信頼できるユーザーの制約値および属性を定義します。

注意: この属性は、クライアント側では適用されません。

"mapping"

信頼できるユーザーのマッピング属性を定義します。

"-name"

属性ルールの名前。

注意: この属性は、クライアント側では適用されません。

"name-id"

信頼できるDNとして受け入れるユーザーを定義します。

"token-attribute-rule"

1つのトークン属性ルールに関する情報をグループ化します。

"tokn-attribute-rules"

すべてのトークン属性ルールに関する情報をグループ化します。

"user-attribute"

信頼できるDNがアサートできるユーザー属性を定義します。

注意: この属性は、クライアント側では適用されません。

"user-mapping-attribute"

信頼できるDNがアサートできるユーザー・マッピング属性を定義します。

"value"

制約フィルタの属性値を定義します。この値には、完全な名前またはワイルドカード文字(*)を含む名前パターン(yourTrusted*など)を使用できます。複数の値は、カンマで区切る必要があります。

注意: この属性は、クライアント側では適用されません。

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して信頼できるDNのトークン属性ルールを作成する方法を示しています。

curl -i -X POST -u username:password --data @createrule.json http://myhost:7001/idaas/webservice/admin/v1/trust/token/mydocument

リクエスト本文の例(サービス側)

次の例は、サービス側で信頼できるDNのトークン属性ルールを作成する場合のJSON形式のリクエスト本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "cn=orcladmin,o=oracle",
"name-id":{
"filter":
{
"value":[ "filter1" ]
},
"mapping":
{
"user-attribute": "val3",
"user-mapping-attribute":"val4"
}
},
"attributes":
[
{
"-name": "tenant1",
"attribute":
{
"filter":
{
"value": [
"filter1",
"filter2"
]
},
"mapping":{
"user-attribute": "val1",
"user-mapping-attribute":"val2"
}
}
}
]
}
]
}
}

リクエスト本文の例(クライアント側)

次の例は、クライアント側でトークン属性ルールを作成する場合のJSON形式のリクエスト本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"mail"
}
},
}
]
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/mysvcInstance1-acme/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"uid"
}
},
}
]
}
}

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded"
}

6.9 すべてのトークン属性のGETメソッド

このGETメソッドは、ドメインのコンテキストに対応するすべてのトークン属性ルール(ドメイン全体に適用されるルール)を参照するために使用します。この操作は、RESTサービスまたはクライアントにより実行できます。クライアント側ではトークン属性のマッピングのみがサポートされます。

RESTリクエスト

GET /idaas/webservice/admin/v1/trust/token

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、すべてのトークン属性ルールに関する次のような情報が含まれます。

属性

説明

"attributes"

信頼できるユーザーの制約フィルタおよびマッピングの属性をグループ化します。

注意: クライアント側では、この属性は必要ではありません。

"-dn"

サービス側では、属性ルールが構成される信頼できるDN。文字列は、RFC 2253に従います(次のURLを参照: http://www.ietf.org/rfc/rfc2253.txt)。

クライアント側では、http(s)://hostまたはhttp(s)://host/rootの形式を使用したURLを指定します。

"filter"

信頼できるユーザーのフィルタ値および属性を定義します。

完全な名前またはワイルドカード文字(*)を含む名前パターン(yourTrusted*など)を入力できます。複数の属性フィルタを指定する場合は、各フィルタをカンマで区切る必要があります。

"mapping"

信頼できるユーザーのマッピング属性を定義します。

注意: この属性は、クライアント側では適用されません。

"-name"

属性ルールの名前。

注意: この属性は、クライアント側では適用されません。

"name-id"

信頼できるDNとして受け入れるユーザーを定義します。

"token-attribute-rule"

1つのトークン属性ルールに関する情報をグループ化します。

"tokn-attribute-rules"

すべてのトークン属性ルールに関する情報をグループ化します。

"user-attribute"

信頼できるDNがアサートできるユーザー属性を定義します。

注意: この属性は、クライアント側では適用されません。

"user-mapping-attribute"

信頼できるDNがアサートできるユーザー・マッピング属性を定義します。

"value"

制約フィルタの属性値を定義します。この値には、完全な名前またはワイルドカード文字(*)を含む名前パターン(yourTrusted*など)を使用できます。複数の値は、カンマで区切る必要があります。

cURLの例

メインに対してテスト済 -- レビュー時にURLの信頼ドキュメント名を削除するように依頼されました。

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、すべてのトークン属性ルールを参照する方法を示しています。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/trust/token

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例(サービス側)

次の例は、サービス側でトークン属性ルールを参照する場合のJSON形式のレスポンス本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "cn=orcladmin,o=oracle",
"attributes":
[
{
"-name": "tenant1",
"attribute":
{
"filter":
{
"value": [
"filter1",
"filter2"
]
},
"mapping":{
"user-attribute": "val1",
"user-mapping-attribute":"val2"
}
}
}
],
"name-id":{
"filter":
{
"value":[ "filter1" ]
},
"mapping":
{
"user-attribute": "val3",
"user-mapping-attribute":"val4"
}
}
}
]
}
}

レスポンス本文の例(クライアント側)

次の例は、クライアント側でトークン属性ルールを参照する場合のJSON形式のレスポンス本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"mail"
}
},
}
]
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/mysvcInstance1-acme/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"uid"
}
},
}
]
}
}

6.10 指定したドキュメント・トークン属性ルールのGETメソッド

このGETメソッドは、特定のドキュメントに対応するトークン属性ルールを参照するために使用します。この操作は、RESTサービスまたはクライアントにより実行できます。クライアント側ではトークン属性のマッピングのみがサポートされます。

RESTリクエスト

GET /idaas/webservice/admin/v1/trust/token/{documentName}

パラメータ

次の表は、GETリクエストのパラメータの概要を示します。

名前

説明

タイプ

documentName

トークン属性ルールを参照するドキュメントの名前。

パス

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

レスポンス本文には、ドキュメントに対応するすべてのトークン属性ルールに関する情報が含まれます。この情報には、次のものが含まれます。

属性

説明

"attributes"

信頼できるユーザーの制約フィルタおよびマッピングの属性をグループ化します。

注意: クライアント側では、この属性は必要ではありません。

"-dn"

サービス側では、属性ルールが構成される信頼できるDN。文字列は、RFC 2253に従います(次のURLを参照: http://www.ietf.org/rfc/rfc2253.txt)。

クライアント側では、http(s)://hostまたはhttp(s)://host/rootの形式を使用したURLを指定します。

"filter"

信頼できるユーザーのフィルタ値および属性を定義します。

完全な名前またはワイルドカード文字(*)を含む名前パターン(yourTrusted*など)を入力できます。複数の属性フィルタを指定する場合は、各フィルタをカンマで区切る必要があります。

"mapping"

信頼できるユーザーのマッピング属性を定義します。

注意: この属性は、クライアント側では適用されません。

"-name"

属性ルールの名前。

注意: この属性は、クライアント側では適用されません。

"name-id"

信頼できるDNとして受け入れるユーザーを定義します。

"token-attribute-rule"

1つのトークン属性ルールに関する情報をグループ化します。

"tokn-attribute-rules"

すべてのトークン属性ルールに関する情報をグループ化します。

"user-attribute"

信頼できるDNがアサートできるユーザー属性を定義します。

注意: この属性は、クライアント側では適用されません。

"user-mapping-attribute"

信頼できるDNがアサートできるユーザー・マッピング属性を定義します。

"value"

制約フィルタの属性値を定義します。この値には、完全な名前またはワイルドカード文字(*)を含む名前パターン(yourTrusted*など)を使用できます。複数の値は、カンマで区切る必要があります。

cURLの例

メインに対してテスト済 -- レビュー時にURLの信頼ドキュメント名を削除するように依頼されました。

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、すべてのトークン属性ルールを参照する方法を示しています。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/trust/token/mydocument

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例(サービス側)

次の例は、サービス側でトークン属性ルールを参照する場合のJSON形式のレスポンス本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "cn=orcladmin,o=oracle",
"attributes":
[
{
"-name": "tenant1",
"attribute":
{
"filter":
{
"value": [
"filter1",
"filter2"
]
},
"mapping":{
"user-attribute": "val1",
"user-mapping-attribute":"val2"
}
}
}
],
"name-id":{
"filter":
{
"value":[ "filter1" ]
},
"mapping":
{
"user-attribute": "val3",
"user-mapping-attribute":"val4"
}
}
}
]
}
}

レスポンス本文の例(クライアント側)

次の例は、クライアント側でトークン属性ルールを参照する場合のJSON形式のレスポンス本文です。

{
"token-attribute-rules":
{
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"mail"
}
},
}
]
"token-attribute-rule":
[
{
"-dn": "https://messaging.us2.com/mysvcInstance1-acme/",
"name-id":{
"mapping":
{
"user-mapping-attribute":"uid"
}
},
}
]
}
}

6.11 信頼ドキュメント名の構成のインポート・メソッド

このPOSTメソッドは、信頼できる発行者の構成(発行者名、識別名(DN)リスト、およびトークン属性ルールを含む)をインポートするために使用します。

RESTリクエスト

POST /idaas/webservice/admin/v1/trustdocument/import

リクエスト本文

リクエスト本文のメディア・タイプ: application/xml

リクエスト本文には、XML形式のインポート・リクエストの詳細が含まれます。信頼できる発行者ドキュメント作成して(「信頼ドキュメント名のPOSTメソッド」を参照)、そのドキュメントをoratrust:name要素を使用して渡す必要があります。次に例を示します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<oratrust:TokenIssuerTrust xmlns:oratrust="http://xmlns.oracle.com/wsm/security/trust" oratrust:name="trustdocument">
<oratrust:Issuers>
<oratrust:Issuer oratrust:name="www.oracle.com" oratrust:tokentype="saml.hok">
<oratrust:TrustedKeys/>
</oratrust:Issuer>
<oratrust:Issuer oratrust:name="www.oracle.com" oratrust:tokentype="saml.sv">
<oratrust:TrustedKeys/>
</oratrust:Issuer>
<oratrust:Issuer oratrust:name="www.oracle.com" oratrust:tokentype="jwt">
<oratrust:TrustedKeys/>
</oratrust:Issuer>
</oratrust:Issuers>
<oratrust:TokenAttributeRules/>
</oratrust:TokenIssuerTrust>

レスポンス本文

レスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

要素

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"Result"

操作結果の詳細。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して、別名のすべての証明書を参照する方法を示しています。

curl -i -X POST -u username:password --data @import.xml -H Content-Type:application/xml -H Accept:application/json http://myhost:7001/idaas/platform/admin/v1/trustdocument/import

リクエスト本文の例

XML形式のリクエスト本文の例を次に示します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<oratrust:TokenIssuerTrust xmlns:oratrust="http://xmlns.oracle.com/wsm/security/trust" oratrust:name="test">
<oratrust:Issuers>
<oratrust:Issuer oratrust:name="www.oracle.com" oratrust:tokentype="saml.hok">
<oratrust:TrustedKeys/>
</oratrust:Issuer>
<oratrust:Issuer oratrust:name="www.oracle.com" oratrust:tokentype="saml.sv">
<oratrust:TrustedKeys/>
</oratrust:Issuer>
<oratrust:Issuer oratrust:name="www.oracle.com" oratrust:tokentype="jwt">
<oratrust:TrustedKeys/>
</oratrust:Issuer>
</oratrust:Issuers>
<oratrust:TokenAttributeRules/>
</oratrust:TokenIssuerTrust>

6.12 信頼ドキュメントのGETメソッド

このGETメソッドは、信頼できる発行者ドキュメントの構成の詳細を参照するために使用します。

RESTリクエスト

GET /idaas/webservice/admin/v1/trustdocument

パラメータ

次の表は、POSTリクエストのパラメータの概要を示します。

名前

説明

タイプ

"documentName"

ドキュメントの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"Result"

操作結果の詳細。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、すべてのトークン属性ルールを参照する方法を示しています。

curl -i -X GET -u username:password http://myhost:7001/idaas/platform/admin/v1/trustdocument?"documentName=myTrustDocument"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS":"Succeeded",
"Result":"List of token issuer trust documents in the Repository:\nDetails of the document matching your request:\nName         : myTrustDocument\tDisplay Name : myTrustDocument\tStatus       : DOCUMENT_STATUS_COMMITED \nList of trusted issuers for this type:\tNone\nList of Token Attribute Rules\tNone"
}

6.13 信頼ドキュメントのDELETEメソッド

Deleteメソッドは、信頼できる発行者ドキュメントを削除するために使用します。

RESTリクエスト

DELETE /idaas/webservice/admin/v1/trustdocument

パラメータ

次の表は、DELETEリクエストのパラメータの概要を示します。

名前

説明

タイプ

"displayName"

ドキュメントの表示名。

問合せ

"documentName"

信頼できる発行者ドキュメントの名前。

問合せ

レスポンス本文

リクエストまたはレスポンス本文のメディア・タイプ: application/json

返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。

属性

説明

"ERROR_CODE"

"STATUS"が"Failed"に設定されている場合はエラー・コードが提供されます。

"ERROR_MSG"

"STATUS"が"Failed"に設定されている場合はエラー・メッセージの内容が提供されます。

"Result"

操作結果の詳細。

"STATUS"

操作のステータス。たとえば、"Succeeded"または"Failed"。

cURLの例

テスト済

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行することで、SAML発行者の信頼ドキュメントを削除する方法を示しています。

curl -i -X DELETE -u username:password http://myhost:7001/idaas/webservice/admin/v1/trustdocument?"documentName=myTrustDocument&displayName=myTrustDocument"

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。

HTTP/1.1 200 OK

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
"STATUS": "Succeeded",
"Result": "Token Issuer Trust document named "myTrustDocument" deleted from the repository."
}

A REST APIのサマリー

資格証明およびキーストアの管理のためのREST APIは、資格証明ストア、キーストアおよびトラスト・ストアを含むWebサービスのセキュリティ管理に使用できる強力なリソースのセットを提供します。

REST APIを使用する前に、RESTリソースにアクセスする方法およびその他の重要な概念を理解する必要があります。「REST APIについて」を参照してください。

次の表は、RESTリソース・パスを、リソース・パスのアルファベット順に要約して示しています。

RESTリソース

メソッド

詳細情報

/idaas/platform/admin/v1/credential

GET

資格証明のGETメソッド

/idaas/platform/admin/v1/credential

DELETE

資格証明のDELETEメソッド

/idaas/platform/admin/v1/credential

POST

資格証明のPOSTメソッド

/idaas/platform/admin/v1/credential

PUT

資格証明のPUTメソッド

/idaas/platform/admin/v1/keystore

GET

JKSキーストアの信頼できる証明書のすべての別名のGETメソッド

/idaas/platform/admin/v1/keystore/{alias}

GET

JKSキーストアの信頼できる証明書の指定した別名のGETメソッド

/idaas/platform/admin/v1/keystore/{alias}

DELETE

JKSキーストアの信頼できる証明書のDELETEメソッド

/idaas/platform/admin/v1/keystore/{alias}

POST

JKSキーストアの信頼できる証明書の特定の別名のPOSTメソッド

/idaas/platform/admin/v1/keystore/pkcs7/{alias}

POST

JKSキーストアの信頼できる証明書の指定した別名のGETメソッド

/idaas/platform/admin/v1/keystoreservice

DELETE

キーストア・サービスKSSキーストアのDELETEメソッド

/idaas/platform/admin/v1/keystoreservice

POST

新しいKSSキーストアのPOSTメソッド

/idaas/platform/admin/v1/keystoreservice

PUT

KSSキーストアのパスワードを更新するPUTメソッド

/idaas/platform/admin/v1/keystoreservice/alias/{stripeName}/{keystoreName}/{entryType}

GET

KSSキーストアの別名のGETメソッド

/idaas/platform/admin/v1/keystoreservice/certificates

GET

KSSキーストアの信頼できる証明書のGETメソッド

/idaas/platform/admin/v1/keystoreservice/certificates

DELETE

KSSキーストアの信頼できる証明書のDELETEメソッド

/idaas/platform/admin/v1/keystoreservice/certificates

POST

KSSキーストアの信頼できる証明書のPOSTメソッド

/idaas/platform/admin/v1/keystoreservice/keystore

POST

KSSキーストアをインポートするPOSTメソッド

/idaas/platform/admin/v1/keystoreservice/secretkey

GET

KSSキーストアの秘密鍵プロパティのGETメソッド

/idaas/platform/admin/v1/keystoreservice/secretkey

POST

KSSキーストアの秘密鍵プロパティのPOSTメソッド

/idaas/platform/admin/v1/keystoreservice/{stripeName}

GET

ストライプのKSSキーストアのGETメソッド

/idaas/webservice/admin/v1/trust/issuers

GET

すべての信頼できる発行者と識別名リストのGETメソッド

/idaas/webservice/admin/v1/trust/issuers/{documentName}

GET

特定のドキュメントの信頼できる発行者と識別名リストのGETメソッド

/idaas/webservice/admin/v1/trust/issuers

POST

ドメインの信頼できる発行者と識別名リストのPOSTメソッド

/idaas/webservice/admin/v1/trust/issuers/{documentName}

POST

ドキュメントの信頼できる発行者と識別名リストのPOSTメソッド

/idaas/webservice/admin/v1/trust/token

GET

すべてのトークン属性のGETメソッド

/idaas/webservice/admin/v1/trust/token/{documentName}

GET

指定したドキュメント・トークン属性ルールのGETメソッド

/idaas/webservice/admin/v1/trust/token

POST

トークン属性ルール識別名のPOSTメソッド(ドメイン・コンテキスト)

/idaas/webservice/admin/v1/trust/token/{documentName}

POST

トークン属性ルール識別名のPOSTメソッド(ドキュメント・コンテキスト)

/idaas/webservice/admin/v1/trustdocument

GET

信頼ドキュメントのGETメソッド

/idaas/webservice/admin/v1/trustdocument

DELETE

信頼ドキュメントのDELETEメソッド

/idaas/webservice/admin/v1/trustdocument

POST

信頼ドキュメント名のPOSTメソッド

/idaas/webservice/admin/v1/trustdocument/import

POST

信頼ドキュメント名の構成のインポート・メソッド