移動先

• リクエスト
• レスポンス
• 例

アプリケーションの暗号化

post

/essbase/rest/v1/applications/{applicationName}/encrypt

Essbaseアプリケーションへの不正アクセスを防止するには、暗号化します。ログインしたEssbaseユーザーのみが、暗号化されたアプリケーションにアクセスできます。

OCID暗号化タイプは、Marketplaceを介したOracle Cloud Infrastructure上のEssbaseスタック・デプロイメントで使用できます。この暗号化タイプでは、マスター暗号化キーおよびシークレットを安全に格納および管理するサービスであるOracle OCI Vaultを使用します。

typeに、OCIDと入力します。vaultIdに、ボールトのOCIDを入力します。masterKeyIdに、マスター暗号化キーのOCIDを入力します。

関連項目

• 暗号化情報の取得
• アプリケーションの復号化

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

本体()

暗号化キー。

ルート・スキーマ: AppEncryption

型: object

ソースの表示

• key: array key
• masterKeyId(required): string

  OCID暗号化タイプに必要です。OCIのOracle Vaultのマスター暗号化キー(MEK)のOCID。

• type(required): string

  サポートされている暗号化タイプ。サポートされている値は、Oracle Vaultのキー管理を表すOCIDのみです。

• vaultId(required): string

  OCID暗号化タイプに必要です。OCIのOracle VaultのOCID。

{
    "type":"object",
    "required":[
        "type",
        "vaultId",
        "masterKeyId"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"<p>The supported encryption type. The only supported value is <code>OCID</code>, representing Oracle Vault key management.</p>"
        },
        "key":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "vaultId":{
            "type":"string",
            "description":"<p>Required for OCID encryption type. The OCID of the Oracle Vault in OCI.</p>"
        },
        "masterKeyId":{
            "type":"string",
            "description":"<p>Required for OCID encryption type. The OCID of the Master Encryption Key (MEK) in the Oracle Vault in OCI.</p>"
        }
    }
}

ネストされたスキーマ : key

型: array

ソースの表示

• 配列: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• text/plain
• application/json
• application/xml

200 レスポンス

成功

暗号化がアプリケーションに適用されました。

400 レスポンス

失敗

アプリケーションへの暗号化の適用に失敗しました。

415 レスポンス

失敗

アプリケーションへの暗号化の適用に失敗しました。

500 レスポンス

失敗

アプリケーションへの暗号化の適用に失敗しました。

先頭に戻る

例

次の例では、Essbaseアプリケーションを暗号化する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X POST -i https://192.0.2.100/essbase/rest/v1/applications/Sample_Dynamic/encrypt -H "Content-Type: application/json" --data "@./appEncryption.json" -u %User%:%Password%

JSONペイロードの例

前述のcURLの例で渡されたappEncryption.jsonの内容を次に示します。vaultIdおよびmasterKeyIdの値を、OCI Vault OCIDおよびマスター暗号化キーOCIDに置き換えます。

{ 
  "type": "OCID",
  "vaultId": "ocid1.vaultid.oc1..<unique_ID>", 
  "masterKeyId": "ocid1.keyId.oc1..<unique_ID>" 
 }

先頭に戻る