ユーザ情報取得
ユーザ情報を取得します。検索条件を指定した場合は、完全一致で検索が行われます。
(1) 必要な権限
GetUserInformation APIを使用するには以下の権限が必要です。
-
システム管理の参照権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
任意のユーザの情報を取得可能
- グループ単位
-
管理対象グループに所属するユーザの情報のみ取得可能
権限がなくても、APIを使用するユーザ自身の情報は取得できます。
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/GetUserInformation
(3) リクエストインタフェース
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
group_id |
グループID （検索条件）（*1） 検索するグループIDを32バイト以内で指定します。 |
半角 |
○ |
ブランク |
||||||||
|
user_id |
ユーザID （検索条件）（*1） 検索するユーザIDを32バイト以内で指定します。 |
半角 |
○ |
ブランク |
||||||||
|
auth_id |
権限グループID （検索条件） 検索する権限グループIDを32バイト以内で指定します。 |
半角 |
○ |
ブランク |
||||||||
|
last_authorized_from |
最終アクセス日（自） （*2） YYYYMMDD形式 |
半角 |
○ |
ブランク |
||||||||
|
last_authorized_to |
最終アクセス日（至） （*2） YYYYMMDD形式 |
半角 |
○ |
ブランク |
||||||||
|
available |
状態 （検索条件）
|
半角 |
○ |
ブランク |
|
*1 |
: |
「system_service」、「everyone」、「unknown」以外の値を指定します。 |
||||||||||||
|
*2 |
: |
last_authorized_from（最終アクセス日（自））とlast_authorized_to（最終アクセス日（至））の指定／未指定による検索パターンは以下のようになります。
|
||||||||||||
|
*3 |
: |
パスワードの有効期限が切れた状態 |
以下は下位互換のために残されている非推奨の項目です。
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||
|---|---|---|---|---|---|---|---|---|
|
include_passwd_flag |
インクルードパスワード
|
半角 |
○ |
false |
(4) レスポンスインタフェース
|
項目名 |
説明 |
備考 |
|---|---|---|
|
info_user |
ユーザ情報 ユーザ情報が単一またはグループID、ユーザIDの昇順で複数返却されます。 |