1. Oracle EssbaseのREST API
  2. タスク
  3. アプリケーション役割プロビジョニング

アプリケーション役割プロビジョニングの検索

get

/essbase/rest/v1/applications/{app}/permissions

指定されたアプリケーションについてプロビジョニング情報を検索します。

EPM共有サービス・セキュリティ・モードを使用している場合、この操作は実行できません。かわりに、共有サービス・コンソールでユーザー、グループおよび権限を管理します。

リクエスト

パス・パラメータ
問合せパラメータ

  • 入力にはall、groupまたはuserを含めることができます。デフォルト値はallです。そのため、この問合せパラメータを指定しなかった場合は、すべてのユーザーおよびグループが返されます。

    デフォルト値: all

  • ユーザーIDまたはグループIDのワイルドカード・パターン。指定した場合は、そのパターンに一致するユーザーおよびグループが返されます。指定しなかった場合は、役割があるすべてのユーザーおよびグループが返されます。役割のないユーザーまたはグループは返されません。

    デフォルト値: *

  • trueの場合は、親グループから派生した役割が考慮に入れられます。デフォルトはfalseです。

    デフォルト値: false

  • 入力にはall、none、または役割(例: app_manager、db_manager、db_updateまたはdb_access)のカンマ区切りリストを含めることができます。デフォルト値はallです。そのため、この問合せパラメータを指定しなかった場合は、役割があるすべてのユーザーおよびグループが返されます。noneを指定した場合は、役割のないユーザーおよびグループのみが返されます。名前で複数の役割を指定した場合、指定した複数の役割のいずれかがあるユーザーおよびグループのみが返されます。

    デフォルト値: all
先頭に戻る

レスポンス

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

200 レスポンス

OK

検索条件に一致するユーザーまたはグループのプロビジョニング情報が正常に返されました。レスポンス・タイプは、Acceptヘッダーに応じてJSON、XMLまたはCSVストリームのいずれかになります。Accept='application/json'またはAccept='application/xml'である場合、検索結果はレスポンス本体で返されます。Accept='application/octet-stream'である場合、検索結果はストリームとして返されます。

本体()
ルート・スキーマ : result
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : permission
型: object
ソースの表示

400 レスポンス

不正なリクエスト

ログインしているユーザーに、適切なアプリケーション役割がない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、cURLでWindowsのシェル・スクリプトからREST APIを呼び出してアプリケーションのプロビジョニング情報を検索する方法を示します。

呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

レスポンスでリンクを必要としない場合は、links=noneを問合せパラメータとして指定します。

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions?id=*&role=all&filter=all&inherited=false" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items": [
    {
      "id": "User001",
      "role": "db_access",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User002",
      "role": "db_update",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User003",
      "role": "db_manager",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User004",
      "role": "app_manager",
      "links": [
        {
          "rel": "get",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "DELETE"
        }
      ]
    }
  ]
}

cURLコマンドを含むスクリプト - リンクなし、出力ファイルに書込み

次の例では、指定ユーザーのアプリケーション権限を取得します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User004?group=false&links=none" -H "Accept: application/json" -o output_get.json -u %User%:%Password%

レスポンス本体の例

次の内容がoutput_get.jsonに書き込まれます。 

{
  "id" : "User004",
  "role" : "app_manager"
}
先頭に戻る