ユーザ一覧
- 印刷する
ユーザ一覧
- 印刷する
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
ユーザ情報の一覧を取得する。
QUERY PARAMETERS
start | number Default: 0 取得開始位置 (先頭は0) |
length | number Default: 100 取得件数 |
sort | string Default: "login_id" ソートキー (返却するユーザ情報のキー名のいずれか) |
order | string Default: "asc" Enum: "asc" "desc" ソート順 |
columns | string 取得する項目 (複数指定する場合は","区切り) |
HEADER PARAMETERS
Authorization required | string 認証情報 (付録参照) |
Accept required | string Value: "application/json" レスポンスの形式 |
X-iDoperation-User-Key | string Default: login_id Enum: "id" "login_id" ユーザ識別キー |
X-iDoperation-User-Value | string ユーザ識別情報 |
Responses
RESPONSE SCHEMA: application/json
total required | integer ユーザ件数 | ||||||||||||||||||||||||||||||||
start required | integer 取得開始位置 (先頭は0) | ||||||||||||||||||||||||||||||||
length required | integer 取得件数 | ||||||||||||||||||||||||||||||||
sort required | string ソートキー | ||||||||||||||||||||||||||||||||
order required | string ソート順 | ||||||||||||||||||||||||||||||||
required | Array of objects (User) ユーザ情報 | ||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||
Response samples
200
Content type
application/json
{
"total": 2,
"start": 0,
"length": 2,
"sort": "login_id",
"order": "asc",
"users": [
{
"id": "89ff0b48-e180-43b2-b932-486a4ff90d2b",
"login_id": "idadmin@example.com",
"is_external": 0,
"services": [1,
2
],
"name": "iDoperation Administrator",
"is_initial_user": 1,
"is_administrator": 1,
"logged_in_at": "2023-05-16T00:00:00.000Z",
"is_disabled": 0,
"locale": "ja",
"is_notified": 1,
"memo": null,
"user_groups": [
{
"id": "43b8f00b-933f-4a87-b907-3fec64a41f6e",
"name": "Root"
}
]
},
{
"id": "df87eb73-9135-41ad-95a7-6954f95e6302",
"login_id": "user@example.com",
"is_external": 0,
"services": 1,
"name": "Sample User",
"is_initial_user": 0,
"is_administrator": 0,
"logged_in_at": "2023-05-16T01:00:00.000Z",
"is_disabled": 0,
"locale": "ja",
"is_notified": 1,
"memo": "メモ",
"user_groups": [
{
"id": "43b8f00b-933f-4a87-b907-3fec64a41f6e",
"name": "Root"
}
]
}
]
}