Oracle® Fusion Middleware Oracle Platform Security Services REST API 12c (12.2.1.3.0) E91957-01 |
|
![]() 前 |
![]() 次 |
セクション | メソッド | リソース・パス |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
新しいキーストア・サービス(KSS)キーストアを作成するには、POSTメソッドを使用します。
RESTリクエスト
POST /opss/v2/keystoreservice
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
リクエスト本文には、作成リクエストの詳細が含まれます。
属性 | 説明 | 必須 |
---|---|---|
|
KSSキーストアを含めるストライプの名前。 |
はい |
|
KSSキーストアの名前。 |
はい |
|
KSSキーストアのパスワード。 |
いいえ |
|
権限ベースのキーストアを作成するかどうかを指定するブール値。 |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、作成操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアを作成する方法を示しています。
curl -i -X POST -u username:password --data @createkss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{ "stripeName" : "myStripe", "keystoreName" : "myKeystore", "keystorePassword" : "myPwd", "permissionBased" : "false" }
注意:
権限に基づくキーストア("permission" : "true"
)を作成していないかぎり、パスワードは必須です。
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED" }
権限ベースのキーストアを作成する例
JSON形式のリクエスト本文の例を次に示します。
{ "stripeName" : "myStripe", "keystoreName" : "permKeystore", "permissionBased" : "true" }
JKSキーストア・ファイルからキーストア・サービス(KSS)キーストアをインポートするには、POSTメソッドを使用します。
RESTリクエスト
POST /opss/v2/keystoreservice/keystore
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: multipart/form-data
レスポンス本文には、インポート・リクエストに関する次のような情報が含まれます。
属性 | 説明 | 必須 |
---|---|---|
|
ストライプの名前。 |
はい |
|
キーストア・データのバイト配列 |
はい |
|
JKSキーストアの名前。 |
はい |
|
パスワードで保護されている場合、インポートするローカル・キーストア・ファイルのパスワードおよびキーストア・エントリ。 |
いいえ |
|
キーストア・タイプ。この値は |
はい |
|
|
はい |
|
|
いいえ |
|
権限ベースのキーストアとしてインポートするかどうかを指定するブール値。 |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、インポート操作に関する次のような情報が含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
成功メッセージ。 |
cURLの例
次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアをインポートする方法を示しています。
curl -i -X PUT -u username:password --data @updatekss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/keystore
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
"stripeName" : "myStripe", "keystoreName" : "myKeystore", "keyAliasList" : ["myAlias"], "keystorePassword" : "welcome1", "keyPasswordList" : ["welcome"], "keystoreType" : "JKS", "permissionBased" : "false", "keystoreImportBytes" : [-2, -19, -2, -19, 0, 0, 0, 2, 0, 0, 0, 1, 0, 0, 0, 2, 0, 6, 109, 121, 99, 101, 114, 116, 0, 0, 1, 86, 125, 119, -27, 113, 0, 5, 88, 46, 53, 48, 57, 0, 0, 3, -61, 48, -126, 3, -65, 48, -126, 2, -89, -96, 3, 2, 1, 2, 2, 16, 64, 4, 72, -122, -60, 65, -17, 59, 100, 58, -128, 102, 64, -102, -4, -96, 48, 13, 6, 9, 42, -122, 72, -122, -9, 13, 1, 1, 11, 5, 0, 48, 120, 49, 11, 48, 9, 6, 3, 85, 4, 6, 19, 2, 85, 83, 49, 16, 65, -117, -74] }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "SUCCESS_MSG":"Aliases: myAlias imported successfully" }
キーストア・サービス(KSS)キーストアのパスワードを更新するには、PUTメソッドを使用します。
RESTリクエスト
PUT /opss/v2/keystoreservice
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、ロード・バランサのパッチに関する次のような情報が含まれます。
属性 | 説明 | 必須 |
---|---|---|
|
ストライプの名前。 |
はい |
|
KSSキーストアの名前。 |
はい |
|
キーストアの新しいパスワード。 |
はい |
|
キーストアの旧パスワード。 |
はい |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、更新操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにPUTリクエストを発行してKSSキーストアをインポートする方法を示しています。
curl -i -X PUT -u username:password --data @updatekss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{ "stripeName" : "myStripe", "keystoreName" : "mykssstore", "oldPassword" : "myPwd", "newPassword" : "myNewPwd" }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED" }
キーストア・サービス(KSS)キーストアに信頼できる証明書をインポートするには、POSTメソッドを使用します。
RESTリクエスト
POST /opss/v2/keystoreservice/certificates
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、インポート・リクエストに関する次のような情報が含まれます。
属性 | 説明 | 必須 |
---|---|---|
|
信頼できる証明書の別名を含むリスト。 |
はい |
|
Base64でエンコードされた証明書。 |
はい |
|
キーストア・エントリのタイプ。有効な値には、 |
はい |
|
KSSキーストアの名前。 |
はい |
|
ストライプの名前。 |
はい |
|
KSSキーストアのパスワード。 |
いいえ |
“keyPasswordList” |
信頼できる証明書のキー・パスワードを含むリスト。 |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
|
インポートされたサブジェクトDNのリスト。 |
cURLの例
次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してKSSキーストアを作成する方法を示しています。
curl -i -X POST -u username:password --data @importcertkss.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/certificates
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{ "keyAliasList" : ["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=", "keystoreType" : "TrustedCertificate", "keystoreName" : "myKeystore", "stripeName" : "myStripe", "keystorePassword" : "myPwd" "keyPasswordList" : ["mykeyPwd"] }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。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" }
ストライプのすべてのキーストア・サービス(KSS)キーストアを返すには、GETメソッドを使用します。
RESTリクエスト
GET /opss/v2/keystoreservice/{stripeName}
パラメータ
次の表は、GETリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
すべてのKSSキーストアを参照するストライプの名前。 |
パス |
はい |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、証明書に関する次のような情報が含まれます。
属性 | 説明 |
---|---|
|
ストライプ内のキーストアのリスト。 |
cURLの例
次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。
curl -i -X GET -u username:password https://myhost:7001/opss/v2/keystoreservice/myStripe
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "keystores":["trust","castore"] }
キーストア・サービス(KSS)キーストアの別名を表示するには、GETメソッドを使用します。
RESTリクエスト
GET /opss/v2/keystoreservice/alias/{stripeName}/{keystoreName}/{entryType}
パラメータ
次の表は、GETリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
パス |
はい |
|
キーストアの名前。 |
パス |
はい |
|
キーストア・タイプ。有効な値には、 |
パス |
はい |
keystorePassword |
Base64でエンコードされたキーストア・パスワード |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、証明書に関する次のような情報が含まれます。
属性 | 説明 |
---|---|
|
ストライプ内のキーストア別名のリスト。 |
cURLの例
次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。
curl -i -X GET -u username:password https://myhost:7001/opss/v2/keystoreservice/alias/myStripe/myKeystore/TrustedCertificate
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "Alias":["myAlias"] }
キーストア・サービス(KSS)キーストアの信頼できる証明書を表示するには、GETメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。
RESTリクエスト
GET /opss/v2/keystoreservice/certificates
パラメータ
次の表は、GETリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
問合せ |
はい |
|
キーストアの名前。 |
問合せ |
はい |
|
信頼できる証明書の別名。 |
問合せ |
はい |
|
キーストア・エントリのタイプ。有効な値には、 |
問合せ |
はい |
|
KSSキーストアのパスワード。 |
ヘッダー |
いいえ |
|
キーのパスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、証明書に関する次のような情報が含まれます。
属性 | 説明 |
---|---|
|
Base64でエンコードされた証明書の内容。 |
|
特定目的の証明書の発行に使用されるオプションの拡張機能。拡張には次が含まれます。
|
|
信頼できる識別名のリスト。 |
|
証明書が期限切れになる日付。 |
|
証明書が有効になる日付。 |
|
JKSキーストアのシリアル番号。 |
|
Base64でエンコードされた署名キー。 |
|
別名の署名アルゴリズム。 |
|
サブジェクト識別名のリスト。 |
|
公開鍵値の文字列。 |
cURLの例
次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。
curl -i -X GET -u username:password -H keystorePassword:cHdkMQ== -H keyPassword:bXlQd2Qy https://myhost:7001/opss/v2/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", "PUBLIC_KEY": "MIIBtzCCASwGByqGSM44BAEwggEfAoGBAP1/U4EddRIpUt9KnC7s5Of2EbdSPO9EAMMeP4C2USZpRV1AIlH7WT2NWPq/xfW6MPbLm1Vs14E7gB00b/JmYLdrmVClpJ+f6AR7ECLCT7up1/63xhv4O1fnxqimFQ8E+4P208UewwI1VBNaFpEy9nXzrith1yrv8iIDGZ3RSAHHAhUAl2BQjxUjC8yykrmCouuEC/BYHPUCgYEA9+GghdabPd7LvKtcNrhXuXmUr7v6OuqC+VdMCz0HgmdRWVeOutRZT+ZxBxCBgLRJFnEj6EwoFhO3zwkyjMim4TwWeotUfI0o4KOuHiuzpnWRbqN/C/ohNWLx+2J6ASQ7zKTxvqhRkImog9/hWuWfBpKLZl6Ae1UlZAFMO/7PSSoDgYQAAoGAa785I6M5r+rek9BjSREtUd8qUbAbPFS19oNxqLR3eyobf0wo+B4pHpWQ3bi9LfekeUOAN7KzoEiGftCDUbNREfMtUN+y8iTX8qmJ+SqiwZTfW4UmAH3LiKY8CFxlXy0BnQcg+7a+D0r2UMdfCuqevB1Aofo10E/fu592VCAcx+U=""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)キーストアから証明書を削除するには、DELETEメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。
RESTリクエスト
DELETE /opss/v2/keystoreservice/certificates
パラメータ
次の表は、DELETEリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
問合せ |
はい |
|
キーストアの名前。 |
問合せ |
はい |
|
KSSキーストアの証明書の別名。 |
問合せ |
はい |
|
Base64でエンコードされたキーストア・パスワード。 |
ヘッダー |
いいえ |
|
Base64でエンコードされたキー・パスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。
curl -i -X DELETE -u username:password -H keystorePassword:cHdkMQ== -H keyPassword:bXlQd2Qy https://myhost:7001/opss/v2/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myAlias"
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED" }
KSSキーストアの対称暗号化/復号化に使用される秘密鍵を作成するには、POSTメソッドを使用します。
RESTリクエスト
POST /opss/v2/keystoreservice/secretkey
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
リクエスト本文には、作成リクエストの詳細が含まれます。
属性 | 説明 | 必須 |
---|---|---|
|
ストライプの名前。 |
はい |
|
KSSキーストアの名前。 |
はい |
|
秘密鍵の別名を含むリスト。 |
はい |
|
暗号アルゴリズムで使用されるキーのサイズ(ビット単位)。 |
はい |
|
メッセージ保護に使用される暗号アルゴリズムの特性を制御します。 |
はい |
|
KSSキーストアのパスワード。 |
いいえ |
|
鍵のパスワードを含むリスト。 |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して秘密鍵を作成する方法を示しています。
curl -i -X POST -u username:password --data @secretkey.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/secretkey
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{ "stripeName" : "myStripe", "keystoreName" : "myKeystore", "keyAliasList" : ["myKeyAlias"], "keySize" : "56", "keyAlgorithm" : "DES", "keystorePassword" : "myPwd", "keyPasswordList" : ["myKeyPwd"] }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED" }
KSSキーストアの秘密鍵のプロパティを表示するには、GETメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。
RESTリクエスト
GET /opss/v2/keystoreservice/secretkey
パラメータ
次の表は、GETリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
問合せ |
はい |
|
キーストアの名前。 |
問合せ |
はい |
|
秘密鍵の別名。 |
問合せ |
はい |
|
出力でキーが返されるかどうか。 |
問合せ |
いいえ |
|
Base64でエンコードされたキーストア・パスワード。 |
ヘッダー |
いいえ |
|
Base64でエンコードされたキー・パスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、証明書に関する次のような情報が含まれます。
属性 | 説明 |
---|---|
|
秘密鍵プロパティのリスト。 |
"secret key" |
"returnKeyInResponse"がtrueに設定されている場合は、秘密鍵データの文字列 |
cURLの例
次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、別名のすべての証明書を参照する方法を示しています。
curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/secretkey?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias"
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "keystore properties":["DES"] }
次の例は、秘密鍵値を含む別名の秘密鍵のプロパティを表示する方法を示しています
curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/secretkey?stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias&returnKeyInResponse=true
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "keystore properties":["DES"], "secret key": "f65uMWvxAdM=" }
秘密鍵を削除するには、DELETEメソッドを使用します。
RESTリクエスト
DELETE /opss/v2/keystoreservice/secretkey
パラメータ
次の表は、DELETEリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
問合せ |
はい |
|
キーストアの名前。 |
問合せ |
はい |
|
秘密鍵の別名。 |
問合せ |
はい |
|
KSSキーストアのパスワード。 |
ヘッダー |
いいえ |
|
キーのパスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから秘密鍵を削除する方法を示しています。
curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/secretkey?"stripeName=myStripe&keystoreName=myKeystore"
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス・ヘッダーの例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED" }
KSSキーストアの対称暗号化/復号化に使用されるキー・ペアを作成するには、POSTメソッドを使用します。
RESTリクエスト
POST /opss/v2/keystoreservice/keypair
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
リクエスト本文には、作成リクエストの詳細が含まれます。
属性 | 説明 | 必須 |
---|---|---|
|
ストライプの名前。 |
はい |
|
KSSキーストアの名前。 |
はい |
|
秘密鍵の別名を含むリスト。 |
はい |
|
暗号アルゴリズムで使用されるキーのサイズ(ビット単位)。 |
はい |
|
メッセージ保護に使用される暗号アルゴリズムの特性を制御します |
はい |
|
キーの識別名 |
はい |
|
KSSキーストアのパスワード。 |
いいえ |
|
キーのパスワード。 |
いいえ |
"keyPasswordList" |
リストのパスワードを含むリスト。 |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、インポート操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してキー・ペアを作成する方法を示しています。
curl -i -X POST -u username:password --data @keypair.json -H Content-Type:application/json https://myhost:7001/opss/v2/keystoreservice/keypair
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{ "stripeName" : "myStripe", "keystoreName" : "myKeystore", "keyAliasList" : ["myKeyAlias"], "keySize" : "256", "algorithm" : "EC", "DN" : "CN=CertGenCA,OU=FORTESTINGONLY,O=MyOrganization,L=MyTown,ST=MyState,C=US", "keystorePassword" : "myPwd", "keyPasswordList" : ["myKeyPwd"] }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED" }
KSSキーストアのキー・ペアを表示するには、GETメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアおよびキーのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。
RESTリクエスト
GET /opss/v2/keystoreservice/keypair
パラメータ
次の表は、GETリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
問合せ |
はい |
|
キーストアの名前。 |
問合せ |
はい |
|
秘密鍵の別名。 |
問合せ |
はい |
|
KSSキーストアのパスワード。 |
ヘッダー |
いいえ |
|
キーのパスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、get操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
Base64でエンコードされた秘密鍵 |
cURLの例
次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、キー・ペアを参照する方法を示しています。
curl -i -X GET -u username:password -H keystorePassword:bXlQd2Q= -H keyPassword:bXlLZXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/keypair?stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "private key": "MEECAQAwEwYHKoZIzj0CAQYIKoZIzj0DAQcEJzAlAgEBBCBzQbYz6xUZjr/XuwVMJj1XXQCquis0f9q5SD9NXhlBjw==" }
キー・ペアを削除するには、DELETEメソッドを使用します。
RESTリクエスト
DELETE /opss/v2/keystoreservice/keypair
パラメータ
次の表は、DELETEリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
|
ストライプの名前。 |
問合せ |
はい |
|
キーストアの名前。 |
問合せ |
はい |
|
鍵ペアの別名。 |
問合せ |
はい |
|
Base64でエンコードされたキーストア・パスワード。 |
ヘッダー |
いいえ |
|
Base64でエンコードされたキー・パスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアからキー・ペアを削除する方法を示しています。
curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q= https://myhost:7001/opss/v2/keystoreservice/keypair?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myKeyAlias"
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "STATUS": "SUCCEEDED"" }
キーストア・サービス(KSS)キーストアを削除するには、DELETEメソッドを使用します。キーストアがパスワードで保護されている場合は、キーストアのパスワードをBase64でエンコードされたヘッダー値として送信する必要があります。
RESTリクエスト
DELETE /opss/v2/keystoreservice
パラメータ
次の表は、DELETEリクエストのパラメータの概要を示します。
名前 | 説明 | タイプ | 必須 |
---|---|---|---|
" |
ストライプの名前。 |
問合せ |
はい |
" |
キーストアの名前。 |
問合せ |
はい |
|
キーストアのパスワード。 |
ヘッダー |
いいえ |
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
返されるレスポンス本文には、削除操作に関する次のようなステータスが含まれます。
属性 | 説明 |
---|---|
|
|
|
|
|
操作のステータス。たとえば、 |
cURLの例
次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行してキーストアから信頼できる証明書を削除する方法を示しています。
curl -i -X DELETE -u username:password -H keystorePassword:bXlQd2Q= https://myhost:7001/opss/v2/keystoreservice?"stripeName=myStripe&keystoreName=myKeystore"
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 204 No Content