移動先

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

サービス役割プロビジョニングの検索

get

/essbase/rest/v1/permissions

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

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

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

リクエスト

問合せパラメータ

• filter: string

  検索フィルタ。指定可能な値は、all/group/userです。デフォルト値はallです。そのため、この問合せパラメータが指定されていない場合は、役割があるすべてのユーザーおよびグループが返されます。

  デフォルト値: all
• id: string

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

  デフォルト値: *
• role: string

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

  デフォルト値: all

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ユーザーおよびグループのプロビジョニング結果が正常に返されました。

本体()

ルート・スキーマ : result

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupProvisionInfo"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

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

型: array

ソースの表示

• 配列: object permission

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

ネストされたスキーマ : 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 レスポンス

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

先頭に戻る

例

次の例では、サービス役割プロビジョニング情報の検索方法を示します。

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

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

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

この例では、power_user役割がプロビジョニングされているすべてのユーザーおよびグループを検索します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/permissions?id=*&role=power_user&filter=all&links=none" -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

3人のユーザーと1つのグループにpower_user役割があります。

{
  "items" : [ {
    "id" : "power3",
    "role" : "power_user"
  }, {
    "id" : "power1",
    "role" : "power_user"
  }, {
    "id" : "power2",
    "role" : "power_user"
  }, {
    "id" : "powergroup",
    "group" : true,
    "role" : "power_user"
  } ]
}

先頭に戻る