Oracle Essbase REST API

アプリケーションのセキュリティ設定の取得

get

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

指定されたアプリケーションのセキュリティ設定を返します。

リクエスト

パス・パラメータ

applicationName(required): string

アプリケーション名。

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

セキュリティの設定が正常に返されました。

ルート・スキーマ : security

型: object

アプリケーションのセキュリティ設定。

ソースの表示

allowCommands: boolean

trueの場合、十分な権限を持つすべてのユーザーが、アプリケーションのデータベース(キューブ)にリクエストを実行できます。デフォルトでは、コマンドは使用可能になっています。falseに設定した場合、管理者を含むいずれのユーザーのリクエストも許可されません。falseの設定は、発行者のセッションの間のみ有効です。false設定は即時有効になり、現在ログインしているユーザーと、発行者のセッション中に後からログインするユーザーに影響します。
allowConnects: boolean

trueの場合、十分な権限を持つすべてのユーザーが、アプリケーションのデータベース(キューブ)に接続できます。デフォルトでは、接続は有効になっています。falseの場合、アプリケーション・マネージャより低い権限を持つユーザーは、キューブを起動することも、キューブの起動が必要な接続を実行することもできません。
allowUpdates: boolean

trueの場合、十分な権限を持つすべてのユーザーが、アプリケーションのデータベース(キューブ)にリクエストを実行できます。デフォルトでは、更新は有効になっています。falseに設定した場合、更新は、発行者のセッションの間継続して禁止されます。

{
    "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 レスポンス

不正なリクエスト

セキュリティ設定の取得に失敗しました。アプリケーション名が正しくない可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbaseアプリケーションのセキュリティ関連設定を取得する方法を示します。

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

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

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%

レスポンス本体の例

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

先頭に戻る