Jump to

• Request
• Response
• Examples

Encrypt Application

post

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

To prevent unauthorized access to the Essbase application, encrypt it. Only logged in Essbase users can access encrypted applications.

OCID encryption type is available for Essbase stack deployments on Oracle Cloud Infrastructure via Marketplace. This encryption type uses Oracle OCI Vault, a service that securely stores and manages master encryption keys and secrets.

For type, enter OCID. For vaultId, enter the OCID of the Vault. For masterKeyId, enter the OCID of the Master Encryption Key.

See Also

• Get Encryption Info
• Decrypt Application

Request

Path Parameters

• applicationName(required): string

  Application name.

Body ()

Encryption Key.

Root Schema : AppEncryption

Type: object

Show Source

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

  Required for OCID encryption type. The OCID of the Master Encryption Key (MEK) in the Oracle Vault in OCI.

• type(required): string

  The supported encryption type. The only supported value is OCID, representing Oracle Vault key management.

• vaultId(required): string

  Required for OCID encryption type. The OCID of the Oracle Vault in OCI.

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

Nested Schema : key

Type: array

Show Source

• Array of: string(byte)

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

Back to Top

Response

Supported Media Types

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

200 Response

SUCCESS

Encryption applied on the application.

400 Response

FAILURE

Failed to apply encryption on the application.

415 Response

FAILURE

Failed to apply encryption on the application.

500 Response

FAILURE

Failed to apply encryption on the application.

Back to Top

Examples

The following example shows how to encrypt an Essbase application.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

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%

Example of JSON Payload

The following are the contents of appEncryption.json passed in the cURL example above. Replace the values for vaultId and masterKeyId with your OCI Vault OCID and master encryption key OCID.

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

Back to Top