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

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

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

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

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

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

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

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

参照先	メソッド	リソース・パス
資格証明のPOSTメソッド	`POST`	`/idaas/platform/admin/v1/credential`
資格証明のGETメソッド	`GET`	`/idaas/platform/admin/v1/credential`
資格証明のPUTメソッド	`PUT`	`/idaas/platform/admin/v1/credential`
資格証明のDELETEメソッド	`DELETE`	`/idaas/platform/admin/v1/credential`

資格証明のPOSTメソッド

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

RESTリクエスト

POST /idaas/platform/admin/v1/credential

リクエスト本文

メディア・タイプ:

application/json

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

属性	説明	必須
`"credential"`	資格証明のパスワード。	はい
`"key"`	キーの名前。	はい
`"map"`	マップ(フォルダ)の名前。	はい
`"username"`	資格証明のユーザー名。	はい

レスポンス本文

メディア・タイプ:

application/json

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

属性	説明
`"ERROR_CODE"`	`"STATUS"`が`"Failed"`に設定されている場合はエラー・コードが提供されます。
`"ERROR_MSG"`	`"STATUS"`が`"Failed"`に設定されている場合はエラー・メッセージの内容が提供されます。
`"STATUS"`	操作のステータス。たとえば、`"Succeeded"`または`"Failed"`。

cURLの例

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

テスト済

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

リクエスト本文の例

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

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
    "STATUS": "Succeeded"
}

資格証明のGETメソッド

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

RESTリクエスト

GET /idaas/platform/admin/v1/credential

レスポンス本文

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

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

属性	説明
`"CSF_MAP_NAME"`	資格証明ストア・マップ名。
`"default"`	デフォルトの資格証明マップのキー・リスト。
`"oracle.wsm.security"`	Oracle Web Services Manager (Oracle WSM)セキュリティ資格証明マップのキー・リスト。

cURLの例

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

テスト済

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

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

資格証明のPUTメソッド

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

RESTリクエスト

PUT /idaas/platform/admin/v1/credential

リクエスト本文

メディア・タイプ:

application/json

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

属性	説明	必須
`"credential"`	キーストア内のキーの更新後のパスワード。	はい
`"key"`	変更するキーの名前。キーが存在する必要があります。	はい
`"map"`	変更するマップ(フォルダ)の名前。	はい
`"username"`	キーストア内のキーのユーザー名。	はい

レスポンス本文

メディア・タイプ:

application/json

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

属性	説明
`"ERROR_CODE"`	`"STATUS"`が`"Failed"`に設定されている場合はエラー・コードが提供されます。
`"ERROR_MSG"`	`"STATUS"`が`"Failed"`に設定されている場合はエラー・メッセージの内容が提供されます。
`"STATUS"`	操作のステータス。たとえば、`"Succeeded"`または`"Failed"`。

cURLの例

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

テスト済

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

リクエスト本文の例

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

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
    "STATUS": "Succeeded"
}

資格証明のDELETEメソッド

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

RESTリクエスト

DELETE /idaas/platform/admin/v1/credential

パラメータ

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

名前	説明	タイプ
`"key"`	削除する資格証明のキーの名前。	問合せ
`"map"`	削除する資格証明のマップ(フォルダ)の名前。	問合せ

レスポンス本文

メディア・タイプ:

application/json

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

属性	説明
`"ERROR_CODE"`	`"STATUS"`が`"Failed"`に設定されている場合はエラー・コードが提供されます。
`"ERROR_MSG"`	`"STATUS"`が`"Failed"`に設定されている場合はエラー・メッセージの内容が提供されます。
`"STATUS"`	操作のステータス。たとえば、`"Succeeded"`または`"Failed"`。

cURLの例

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

テスト済

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

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

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

HTTP/1.1 200 OK

レスポンス本文の例

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

{
    "STATUS": "Succeeded"
}