移動先

• リクエスト
• レスポンス
• 例

サービス役割プロビジョニングの取得

get

/essbase/rest/v1/permissions/{id}

Essbaseサービス役割プロビジョニング情報を取得します。サービス役割には、サービス管理者、パワー・ユーザーおよびユーザーが含まれます。

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

「アプリケーション役割プロビジョニングの取得」も参照してください。

リクエスト

パス・パラメータ

• id(required): string

  ユーザーIDまたはグループID

問合せパラメータ

• group: boolean

  trueの場合、IDはグループのIDとなります。falseの場合、IDはユーザーのIDとなります。デフォルトはfalseです(IDはユーザーのIDと見なされる。)

  デフォルト値: false

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

プロビジョニング情報が正常に返されました。

本体()

ルート・スキーマ : permission

型: object

ソースの表示

• group: boolean

  trueまたはfalse。idがグループを参照するかどうか。

• id: string

  ユーザーIDまたはグループID

• links: array links
• name: string

  ユーザー名またはグループ名。

• role: string

  ユーザーまたはグループの役割。

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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/permissions/user2?links=none" -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "id" : "user2",
  "role" : "user"
}

cURLコマンドを含むスクリプト - グループ情報

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

レスポンス本体の例

{
  "id" : "powergroup",
  "group" : true,
  "role" : "power_user"
}

先頭に戻る