移動先

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

グループ・ユーザーの取得

get

/essbase/rest/v1/groups/{id}/members/users

1つのグループのユーザー・メンバーを取得します。

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

リクエスト

パス・パラメータ

• id(required): string

  グループのID。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

グループ・メンバー・リストが正常に返されました。

本体()

ルート・スキーマ : Users

型: 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/UserBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object User

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• email: string
• groups: array groups

  このユーザーに関連付けられているグループ名のカンマ区切りリスト。

• id: string

  ユーザーID。

• links: array links
• name: string

  ユーザー名。256文字以内で入力してください。特殊文字; , = + * ? [ ] | < > \ " ' / スペース タブは使用できません。また、ピリオド(.)はグループ名で使用できません。

• password: string

  ユーザーのパスワード。

• role: string

  ユーザーの役割。有効な役割は、ユーザー、パワー・ユーザーおよびサービス管理者です。

• token: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "token":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "description":"<p>Comma-separated list of group names associated with this user.</p>",
            "items":{
                "type":"string"
            }
        },
        "role":{
            "type":"string",
            "description":"<p>The user role. Valid roles: <b>User</b>, <b>Power User</b>, and <b>Service Administrator</b>.</p>"
        },
        "password":{
            "type":"string",
            "description":"<p>Password for the user.</p>"
        },
        "id":{
            "type":"string",
            "description":"<p>The user ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The user name. Limit 256 characters. The following special characters are not permitted: <code>; , = + * ? [ ] | < > \\ \" ' / Space Tab</code>. Additionally, a period (<code>.</code>) is not permitted in group names.</p>"
        }
    },
    "xml":{
        "name":"User"
    }
}

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

型: array

このユーザーに関連付けられているグループ名のカンマ区切りリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Comma-separated list of group names associated with this user.</p>",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 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内でその変数値が設定されています。

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

次の例では、どのユーザーがグループID sample_appmgrsのメンバーであるかをリクエストします。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/groups/sample_appmgrs/members/users?links=none" -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

AishaとFredはグループのメンバーです。

{
  "items" : [ {
    "id" : "user4",
    "name" : "Aisha",
    "email" : ""
  }, {
    "id" : "user8",
    "name" : "Fred",
    "email" : ""
  } ]
}

先頭に戻る