Oracle® Fusion Middleware

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

11gリリース1 (11.1.1.9)

E61941-03(原本部品番号:E57895-03)

2018年3月

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

Oracle Fusion Middleware Oracle Web Services Managerでの資格証明およびキーストアの管理のためのREST API, 11gリリース1 (11.1.1.9)

E61941-03

Copyright © 2015, 2018, Oracle and/or its affiliates. All rights reserved.

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

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

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

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およびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

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

はじめに

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

- 表記規則

第I部 作業の開始

1 REST APIについて

- REST APIの概要

- URL構造

- サポートされるRESTメソッド

- 認証

- ステータス・コード

- cURLアクセス

2 使用事例

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

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

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

第II部 REST APIリファレンス

3 資格証明ストアの管理

- 資格証明ストアの新しい資格証明の作成

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

- 資格証明ストアの資格証明の更新

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

4 JKSキーストアの管理

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

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

- JKSキーストアへの信頼できるPKCS#7証明書のインポート

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

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

5 KSSキーストアの管理

- KSSキーストアの作成

- KSSキーストアのインポート

- KSSキーストアのパスワードの更新

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

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

- KSSキーストアの別名の参照

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

- KSSキーストアの証明書の削除

- KSSキーストアの秘密鍵の作成

- KSSキーストアの秘密鍵のプロパティの参照

- KSSキーストアの削除

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

- 信頼できる発行者およびDNリストの作成

- 信頼できる発行者およびDNリストの参照

- 信頼できるDNのトークン属性ルールの作成

- すべてのトークン属性ルールの参照

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 Supportへのアクセス

サポートをご購入の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、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

第I部

作業の開始

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

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

- 第1章「REST APIについて」

- 第2章「使用事例」

1 REST APIについて

この項では、資格証明およびキーストアの管理のためのOracle Fusion Middleware Representational State Transfer (REST) APIについて説明します。

トピック:

- REST APIの概要

- URL構造

- サポートされるRESTメソッド

- 認証

- ステータス・コード

- cURLアクセス

REST APIの概要

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

RESTエンドポイントは、次のようなクライアント・アプリケーションからアクセスできます。

- Webブラウザ

- cURL

- GNU Wget

- Postman

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

- JavaScript

- Ruby

- Perl

- Java

- JavaFX

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

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を指定します。

サポートされるRESTメソッド

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

RESTメソッド

タスク

GET

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

POST

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

PUT

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

DELETE

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

認証

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

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

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

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

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

ステータス・コード

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

HTTPステータス・コード

説明

200 OK

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

201 Created

要求が満たされ、新規リソースが作成されます。レスポンスには、新たに作成されたリソースの正規のURIを含むLocationヘッダーが含まれています。
ステータス201は、同期リソースの作成、またはレスポンスが返される前に完了した非同期リソースの作成から返されます。

202 Accepted

要求の処理は受け入れられましたが、処理は完了していません。要求は、実際に処理される時に拒否される可能性があるため、最終的に処理されない場合もあります。
非同期(__detached=true)リソースの作成(アプリケーションのデプロイ時など)または更新(アプリケーションの再デプロイ時など)を指定した場合、操作がまだ進行中である場合に202が返されます。__detached=falseの場合、基本となる操作が適切な時間内に完了しない場合に202が返されることがあります。

クライアントは、レスポンスに含まれるジョブ・リソースのLocationヘッダーを調べて、ジョブが終了した時期を確認する必要があります。ジョブの現在の状態を表すエンティティも返されます。

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アプリケーションは現在実行されていません。

cURLアクセス

このドキュメント内の例では、Oracle Java Cloud ServiceのRESTリソースへのアクセス方法を示すためにcURLを使用しています。

これらの例では、cURLの実行を指示するために次のオプションが1つ以上使用されています。

cURLオプション

説明

--data @file.json

ローカル・マシン上のJSON形式のリクエスト・ドキュメントを識別します。

--form "name=value"

フォーム・データを識別します。

-H

次のうちの1つまたは両方を定義するヘッダー。

- リクエスト・ドキュメントのコンテンツ・タイプ

- Base64で暗号化されたキーストアまたはキーのパスワード。

-i

レスポンス・ヘッダー情報を表示します。

-u username:password

認証のためのWebLogic管理者のユーザー名とパスワードを指定します。

-X

リクエストの種類を指定します(GET、POSTなど)。サポートされるRESTメソッドの詳細は、「サポートされるRESTメソッド」を参照してください。

次に例を示します。

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

cURLのダウンロードおよび使用の詳細は、http://curl.haxx.seを参照してください。

2 使用事例

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

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

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

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

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

次の使用事例に示すREST APIを使用して、資格証明ストア・フレームワークを参照および管理できます。特にこの使用事例では、次の方法を示します。

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

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

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

注意:
資格証明ストアの管理の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』の資格証明ストアの構成に関する項を参照してください。

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

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

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

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

リクエストの属性の詳細は、「資格証明ストアの新しい資格証明の作成」を参照してください。

2. 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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"STATUS": "Succeeded"
}

詳細は、「資格証明ストアの新しい資格証明の作成」を参照してください。

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"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. 資格証明ストアから資格証明を削除します。

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"STATUS": "Succeeded"
}

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

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

詳細は、「JKSキーストア内のすべての別名の参照」を参照してください。

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

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

{   "component":"JKS",
"certificate": "Base64-encoded certificate"
}

リクエストの属性の詳細は、「JKSキーストアへの信頼できる証明書のインポート」を参照してください。

2. 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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

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

詳細は、「JKSキーストアへの信頼できる証明書のインポート」を参照してください。

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"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-----\
Base64-encoded certificate
-----END CERTIFICATE-----",
"SIGNATURE": "Base64-encoded signature key",
"Extensions": "{subjectKeyIDExtension {oid = 2.5.29.14, critical = false, value = f74ca5c1016d848260c749884e2b710c5fecc7b8}}"
}

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

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"STATUS": "Succeeded"
}

詳細は、「JKSキーストアからの信頼できる証明書の削除」を参照してください。

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

次の使用事例に示すREST APIを使用して、キーストア・サービス(KSS)キーストアを参照および管理できます。特にこの使用事例では、次の方法を示します。

- KSSキーストアの作成

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

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

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

- KSSキーストアの削除

注意:
KSSキーストアの管理の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のメッセージ保護のためのOPSSキーストア・サービスの構成に関する項を参照してください。

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

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

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

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

リクエストの属性の詳細は、「KSSキーストアの作成」を参照してください。

2. 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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"STATUS": "Succeeded"
}

詳細は、「KSSキーストアの作成」を参照してください。

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"keystore 1:"myKeystore"
}

詳細は、「ストライプのすべてのKSSキーストアの参照」を参照してください。

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

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

{
"keyAlias" : "myAlias",
"keystoreEntry":
"Base64-encoded certificate",
"keystoreEntryType" : "TrustedCertificate",
"keystoreName" : "myKeystore",
"stripeName" : "myStripe",
"keystorePassword" : "password"
}

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

2. 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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

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

詳細は、「KSSキーストアへの信頼できる証明書のインポート」を参照してください。

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

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

{
"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-----
Base64-encoded certificate
-----END CERTIFICATE-----",
"SIGNATURE":Base64-encoded signature key",
"Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

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

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

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

cURLのコマンド行オプションの詳細は、「cURLアクセス」を参照してください。

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

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

HTTP/1.1 204 No Content

第II部

REST APIリファレンス

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

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

- 第3章「資格証明ストアの管理」

- 第4章「JKSキーストアの管理」

- 第5章「KSSキーストアの管理」

- 第6章「トークン発行者の信頼の管理」

- 付録A「REST APIのサマリー(リソース・パスのアルファベット順)」

3 資格証明ストアの管理

Oracle Web Services Manager (WSM)では、安全な形式で資格証明を管理するために資格証明ストア・フレームワーク(CSF)を使用しています。資格証明ストアは、次に説明するように、一連のRepresentational State Transfer (REST)リソースを使用して参照および管理できます。

REST APIを使用する前に、RESTリソースにアクセスする方法およびその他の重要な概念を理解する必要があります。「REST APIについて」を参照してください。

資格証明ストアの管理の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』の資格証明ストアの構成に関する項を参照してください。

項

メソッド

リソース・パス

資格証明ストアの新しい資格証明の作成

POST

/idaas/platform/admin/v1/credential

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

GET

/idaas/platform/admin/v1/credential

資格証明ストアの資格証明の更新

PUT

/idaas/platform/admin/v1/credential

資格証明ストアの資格証明の削除

DELETE

/idaas/platform/admin/v1/credential

資格証明ストアの新しい資格証明の作成

ドメイン資格証明ストアに新しい資格証明を作成します。

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アクセス」を参照してください。

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/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

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

ドメイン資格証明ストアのすべての資格証明を返します。

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アクセス」を参照してください。

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

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

次にレスポンス・ヘッダーの例を示します。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"
]
}

資格証明ストアの資格証明の更新

ドメイン資格証明ストアの資格証明を更新します。

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アクセス」を参照してください。

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" : "password",
"key" : "mykey",
"map" : "oracle.wsm.security"
}

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

資格証明ストアの資格証明の削除

ドメイン資格証明ストアから資格証明を削除します。

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アクセス」を参照してください。

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

4 JKSキーストアの管理

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

REST APIを使用する前に、RESTリソースにアクセスする方法およびその他の重要な概念を理解する必要があります。「REST APIについて」を参照してください。

JKSキーストアの管理の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のメッセージ保護のためのキーストアの構成に関する項を参照してください。

タスク

メソッド

リソース・パス

JKSキーストア内のすべての別名の参照

GET

/idaas/platform/admin/v1/keystore

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

POST

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

JKSキーストアへの信頼できるPKCS#7証明書のインポート

POST

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

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

GET

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

JKSキーストアからの信頼できる証明書の削除

DELETE

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

JKSキーストア内のすべての別名の参照

JKSキーストア内の信頼できる証明書エントリのすべての別名を返します。

RESTリクエスト

GET /idaas/platform/admin/v1/keystore

レスポンス本文

メディア・タイプ:

application/json

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

属性

説明

"aliases"

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

cURLの例

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

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

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

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

指定した別名で信頼できる証明書を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アクセス」を参照してください。

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": "Base64-encoded certificate"
}

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

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

JKSキーストアへの信頼できるPKCS#7証明書のインポート

指定された別名によって示された秘密鍵に関連付けられた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アクセス」を参照してください。

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": "Base64-encoded certificate",
"keyPassword" : "password"
}

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

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

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

指定した別名で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アクセス」を参照してください。

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

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

次にレスポンス・ヘッダーの例を示します。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-----
Base64-encoded certificate
-----END CERTIFICATE-----",
"SIGNATURE":"Base64-encoded signature key",
"Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

JKSキーストアからの信頼できる証明書の削除

JKSキーストアから、指定した別名を持つ信頼できる証明書(keyStore.TrustedCertificateEntry)を削除します。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アクセス」を参照してください。

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

5 KSSキーストアの管理

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

REST APIを使用する前に、RESTリソースにアクセスする方法およびその他の重要な概念を理解する必要があります。「REST APIについて」を参照してください。

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

表5-1 KSSキーストア管理のRESTリソース

項

メソッド

リソース・パス

KSSキーストアの作成

POST

/idaas/platform/admin/v1/keystoreservice

KSSキーストアのインポート

POST

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

KSSキーストアのパスワードの更新

PUT

/idaas/platform/admin/v1/keystoreservice

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

POST

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

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

GET

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

KSSキーストアの別名の参照

GET

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

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

GET

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

KSSキーストアの証明書の削除

DELETE

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

KSSキーストアの秘密鍵の作成

POST

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

KSSキーストアの秘密鍵のプロパティの参照

GET

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

KSSキーストアの削除

DELETE

/idaas/platform/admin/v1/keystoreservice

KSSキーストアの作成

新しいキーストア・サービス(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アクセス」を参照してください。

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" : "password",
"permission" : "true"
}

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

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

HTTP/1.1 201 Created

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

KSSキーストアのインポート

KSSキーストア・ファイルからキーストア・サービス(KSS)キーストアをインポートします。

RESTリクエスト

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

リクエスト本文

メディア・タイプ:

multipart/form-data

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

属性

説明

"keyAliases"

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

"keyPasswords"

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

"keystoreFile"

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

"keystoreName"

KSSキーストアの名前。

"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アクセス」を参照してください。

curl -i -X POST -u username:password -H Content-Type:multipart/form-data --form "stripeName=myStripe" --form "keystoreFile=@clientkeystore" --form "keystoreName=myKeystore" --form "keystorePassword=password" --form "keystoreType=JKS" --form "keyAliases=client" --form "keyPasswords=password" --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"
}

KSSキーストアのパスワードの更新

キーストア・サービス(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アクセス」を参照してください。

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" : "password",
"newpass" : "password"
}

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

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

キーストア・サービス(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アクセス」を参照してください。

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":
"Base64-encoded certificate",
"keystoreEntryType" : "TrustedCertificate",
"keystoreName" : "myKeystore",
"stripeName" : "myStripe",
"keystorePassword" : "password"
}

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

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

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

ストライプのすべてのキーストア・サービス(KSS)キーストアを返します。

RESTリクエスト

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

パラメータ

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

名前

説明

タイプ

stripeName

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

パス

レスポンス本文

メディア・タイプ:

application/json

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

属性

説明

"keystore n"

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

cURLの例

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

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

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

KSSキーストアの別名の参照

キーストア・サービス(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アクセス」を参照してください。

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"keystore 1":"myAlias",
}

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

キーストア・サービス(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アクセス」を参照してください。

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

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

次にレスポンス・ヘッダーの例を示します。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-----
Base64-encoded certificate
-----END CERTIFICATE-----",
"SIGNATURE":Base64-encoded signature key",
"Extensions":"{subjectKeyIDExtension {oid = 2.5.29.14 critical = false, value = 329b98f6b6225e92ca52513d3bfc43ee02aa9121}}"
}

KSSキーストアの証明書の削除

キーストア・サービス(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アクセス」を参照してください。

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

KSSキーストアの秘密鍵の作成

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アクセス」を参照してください。

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" : "password",
"keyPassword" : "password"
}

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"STATUS": "Succeeded"
}

KSSキーストアの秘密鍵のプロパティの参照

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アクセス」を参照してください。

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
"Property 1":"DES"
}

KSSキーストアの削除

キーストア・サービス(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アクセス」を参照してください。

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

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

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

HTTP/1.1 204 No Content

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

トークン発行者の信頼の構成は、次に説明するように、一連のRepresentational State Transfer (REST)リソースを使用して参照および管理できます。

REST APIを使用する前に、RESTリソースにアクセスする方法およびその他の重要な概念を理解する必要があります。「REST APIについて」を参照してください。

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

項

メソッド

リソース・パス

信頼できる発行者およびDNリストの作成

POST

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

信頼できる発行者およびDNリストの参照

GET

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

信頼できるDNのトークン属性ルールの作成

POST

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

すべてのトークン属性ルールの参照

GET

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

信頼できる発行者およびDNリストの作成

署名証明書の信頼できる発行者および識別名(DN)リストを作成します。信頼できる発行者は、指定された信頼できる発行者ドキュメントに格納されます。

RESTリクエスト

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

パラメータ

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

名前

説明

タイプ

documentName

信頼できる発行者ドキュメントの名前。

問合せ

リクエスト本文

メディア・タイプ:

application/json

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

属性

説明

必須

"dn"

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

はい

"issuer"

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

はい

"-name"

信頼する発行者の名前。たとえば、www.example.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アクセス」を参照してください。

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",
}

信頼できる発行者およびDNリストの参照

指定したドキュメント名に基づいて信頼できる発行者およびその識別名(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アクセス」を参照してください。

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", ]
}
]
}
}
}

信頼できるDNのトークン属性ルールの作成

信頼できる識別名(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アクセス」を参照してください。

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"
}

すべてのトークン属性ルールの参照

信頼ドキュメントのすべてのトークン属性ルールを返します。この操作は、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の例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、すべてのトークン属性ルールを参照する方法を示しています。詳細は、「cURLアクセス」を参照してください。

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"
}
},
}
]
}
}

A REST APIのサマリー(リソース・パスのアルファベット順)

資格証明およびキーストアの管理のためのREST APIは、資格証明ストア、キーストアおよびトラスト・ストアを含むWebサービスのセキュリティ管理に使用できる強力なリソースのセットを提供します。

REST APIを使用する前に、RESTリソースにアクセスする方法およびその他の重要な概念を理解する必要があります。「REST APIについて」を参照してください。

次の表は、RESTリソース・パスを、リソース・パスのアルファベット順に要約して示しています。

RESTリソース

メソッド

詳細

/idaas/platform/admin/v1/credential

GET

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

/idaas/platform/admin/v1/credential

DELETE

資格証明ストアの資格証明の削除

/idaas/platform/admin/v1/credential

POST

資格証明ストアの新しい資格証明の作成

/idaas/platform/admin/v1/credential

PUT

資格証明ストアの資格証明の更新

/idaas/platform/admin/v1/keystore

GET

JKSキーストア内のすべての別名の参照

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

GET

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

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

DELETE

JKSキーストアからの信頼できる証明書の削除

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

POST

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

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

POST

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

/idaas/platform/admin/v1/keystoreservice

DELETE

KSSキーストアの削除

/idaas/platform/admin/v1/keystoreservice

POST

KSSキーストアの作成

/idaas/platform/admin/v1/keystoreservice

PUT

KSSキーストアのパスワードの更新

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

GET

KSSキーストアの別名の参照

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

GET

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

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

DELETE

KSSキーストアの証明書の削除

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

POST

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

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

POST

KSSキーストアのインポート

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

GET

KSSキーストアの秘密鍵のプロパティの参照

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

POST

KSSキーストアの秘密鍵の作成

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

GET

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

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

GET

信頼できる発行者およびDNリストの参照

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

POST

信頼できる発行者およびDNリストの作成

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

GET

すべてのトークン属性ルールの参照

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

POST

信頼できるDNのトークン属性ルールの作成

Oracleの法律上の注意点

コピーライト

Copyright © 1994-2018, Oracle and/or its affiliates. All rights reserved.

ライセンス制約の保証と結果的に生じる損害の免責

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

保証免責

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

制限付権利について

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

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 Corporationおよびその関連会社は一切の責任を負いかねます。

商標と登録商標について

OracleおよびJavaはオラクルおよびその関連会社の登録商標です。その他の社名、商品名等は各社の商標または登録商標である場合があります。

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およびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

Pre-General Availability (一般提供前)版のドキュメントについて

このドキュメントがPre-General Availability (一般提供前)版の場合:

このドキュメントはPre-General Availability (一般提供前)版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。Oracle Corporationおよびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。

非公開のPre-General Availability (一般提供前)版のドキュメントについて

このドキュメントが非公開のPre-General Availability (一般提供前)版の場合:

このドキュメントに含まれる情報は、情報の共有のみを目的としたものであって、顧客諮問委員会(Customer Advisory Board)のメンバーとしてのお客様の立場でのみ、またはお客様のPre-General Availability Trial Agreement (Pre-GAトライアル契約)のみに従って検討されるべきものとします。マテリアル、コード、または機能の提供をお約束するものではなく、購入決定を行う際の判断材料とすべきではありません。このドキュメントに記載されている特徴または機能の開発、リリースおよび時期については、オラクルの裁量により決定されます。

このドキュメントには、ソフトウェアまたは印刷物などの形式を問わず、オラクルが独占的な権利を有する財産的情報が含まれています。この機密資料へのアクセスと使用は、お客様とオラクルとの間で締結され、お客様が遵守に同意した、Oracle Master Agreement、Oracle License and Oracle Services Agreement (オラクル・ライセンスおよびサービスに関する契約書)、Oracle Partner Network Agreement、Oracle Distribution Agreementまたはその他のライセンス契約の条件に従うものとします。このドキュメントとその内容の開示、コピー、複製および配布には、オラクルによる事前の承諾を必要とします。このドキュメントはライセンス契約の一部となるものではなく、オラクルおよびその子会社や関連会社との契約を構成するものではありません。

ドキュメントのアクセシビリティ

オラクルのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

サポートをご契約のお客様には、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)を参照してください。