プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle Web Services Managerでの資格証明およびキーストアの管理のためのREST API
リリース12c 12.2.1.2
E82845-01
目次へ移動
目次
前
前 		次
次

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

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

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

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

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

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
前
前 		次
次
目次へ移動
目次