ユーザーの取得
get
/essbase/rest/v1/users/{id}
指定されたユーザーIDの詳細を取得します。
要求
パス・パラメータ
- id: string
ユーザーのID。
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200 レスポンス
OK
ユーザー詳細が正常に返されました。
ルート・スキーマ : User
タイプ:
Show Source
object- email(optional): string
ユーザーの電子メール・アドレス。
- groups(optional): array groups
このユーザーに関連付けられているグループ名のカンマ区切りリスト。
- id(optional): string
ユーザーID。
- links(optional): array links
- name(optional): string
ユーザー名。 256文字に制限されます。 次の特殊文字は使用できません:
; , = + * ? [ ] | < > \ " ' / Space Tab。 また、グループ名にピリオド(.)は使用できません。 - password(optional): string
ユーザーのパスワード。
- role(optional): string
ユーザー・ロール。 有効なロール: User、パワー・ユーザーおよびサービス管理者。
- token(optional): string
400 レスポンス
不正なリクエスト
ログイン・ユーザーが適切なサービス・ロールを持っていない可能性があります。
404 レスポンス
見つかりません
ユーザーが見つかりません。
500 レスポンス
内部サーバー・エラー。
例
次の例では、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、指定したEssbaseユーザーIDの詳細を取得する方法を示します。
コール元のユーザーIDおよびパスワードは、properties.batで値が設定される変数です。
cURLコマンドを含むスクリプト
call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/users/User001"
-H "accept: application/json"
-u %User%:%Password%レスポンス本体の例
JSON形式のレスポンス本文のコンテンツの例を次に示します:
{
"id": "User001",
"name": "User One",
"email": "user001@example.com",
"role": "User",
"links": [
{
"rel": "get",
"href": "https://192.0.2.1:443/essbase/rest/v1/users/User001",
"method": "GET"
},
{
"rel": "edit",
"href": "https://192.0.2.1:443/essbase/rest/v1/users/User001",
"method": "PUT"
},
{
"rel": "delete",
"href": "https://192.0.2.1:443/essbase/rest/v1/users/User001",
"method": "DELETE"
},
{
"rel": "provisionReport",
"href": "https://192.0.2.1:443/essbase/rest/v1/users/User001/provisionReport",
"method": "GET"
}
]
}