REST API for Oracle Essbase

Get Application Security Settings

get

/essbase/rest/v1/applications/{applicationName}/settings/security

Returns the security settings of the specified application.

Request

Path Parameters

applicationName(required): string

Application name.

Response

Supported Media Types

application/json
application/xml

200 Response

Security settings returned successfully.

Root Schema : security

Type: object

Application security settings.

Show Source

allowCommands: boolean

If true, all users with sufficient permissions can make requests to the database (cube) in the application. By default, commands are enabled. If set to false, no requests are permitted by any user including administrators. The false setting remains in effect only for the duration of the issuer's session. The false setting takes effect immediately, and affects users who are currently logged in, as well as users who log in later during the issuer's session.
allowConnects: boolean

If true, all users with sufficient permissions can make connections to the database (cube) in the application. By default, connections are enabled. If false, no user with a permission lower than Application Manager can start the cube nor make connections that require the cube to be started.
allowUpdates: boolean

If true, all users with sufficient permissions can make requests to the databases (cube) in the application. By default, updates are enabled. If set to false, updates are not permitted, lasting for the duration of the issuer's session.

{
    "type":"object",
    "description":"<p>Application security settings.</p>",
    "properties":{
        "allowCommands":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users with sufficient permissions can make requests to the database (cube) in the application. By default, commands are enabled. If set to <b>false</b>, no requests are permitted by any user including administrators. The <b>false</b> setting remains in effect only for the duration of the issuer's session. The <b>false</b> setting takes effect immediately, and affects users who are currently logged in, as well as users who log in later during the issuer's session.</p>"
        },
        "allowConnects":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users with sufficient permissions can make connections to the database (cube) in the application. By default, connections are enabled. If <b>false</b>, no user with a permission lower than Application Manager can start the cube nor make connections that require the cube to be started.</p>"
        },
        "allowUpdates":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, all users with sufficient permissions can make requests to the databases (cube) in the application. By default, updates are enabled. If set to <b>false</b>, updates are not permitted, lasting for the duration of the issuer's session.</p>"
        }
    },
    "xml":{
        "name":"security"
    }
}

400 Response

Bad Request

Failed to get the security settings. The application name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get security related settings of 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 GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/settings/security?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Example of Response Body

{
  "security" : {
    "allowCommands" : true,
    "allowConnects" : true,
    "allowUpdates" : true
  }
}