REST API for Oracle Essbase

Get Encryption Info

get

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

List the types of encryption supported by Essbase and available for the application.

EncryptionMode

The encryption modes supported in Oracle Essbase.

0 - No encryption.

1 - N/A. Use Oracle OCI Vault instead.

2 - Oracle OCI Vault encryption. OCI Vault is a service that securely stores and manages master encryption keys and secrets.

AvailableTypes

The types of encryption available for this application. Valid values: OCID, or none. OCID/Vault encryption type is available only for Essbase stack deployments on Oracle Cloud Infrastructure via Marketplace. OCID type refers to the OCID of the OCI Vault.

See Also

Request

Path Parameters

applicationName(required): string

Application name.

Response

Supported Media Types

application/json
application/xml

200 Response

Returned supported encryption types successfully.

Root Schema : EncryptionConfig

Type: object

Show Source

essEncryptionMode: integer(int32)
types: array AvailableTypes

{
    "type":"object",
    "properties":{
        "essEncryptionMode":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "name":"EncryptionMode"
            }
        },
        "types":{
            "type":"array",
            "xml":{
                "name":"AvailableTypes"
            },
            "items":{
                "type":"string",
                "xml":{
                    "name":"AvailableTypes"
                }
            }
        }
    }
}

Nested Schema : AvailableTypes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "xml":{
        "name":"AvailableTypes"
    },
    "items":{
        "type":"string",
        "xml":{
            "name":"AvailableTypes"
        }
    }
}

Examples

The following example shows how to list the types of encryption that are supported by Essbase, as well as those that are available for the 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 GET -i "https://192.0.2.100/essbase/rest/v1/applications/Sample/encryptionconfig" -H Accept:application/json -u %User%:%Password%

Example of Response Body

{
  "EncryptionMode" : 2,
  "AvailableTypes" : [ "OCID" ]
}