ユーザー一覧取得

ユーザーの一覧を取得するためのAPIです。Manager画面で[セキュリティ]を選択した後、[ユーザー]タブを選択したときに表示される画面での操作に相当します。

= 備考 =

ユーザー一覧取得APIのcontent階層下のレスポンスパラメータは、ユーザー詳細取得APIのレスポンスパラメータと同じです。

書式

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIキー'

'http://ホスト名:ポート番号/api/v1/user?クエリ形式のリクエスト'

リクエストパラメータ(クエリ形式)
項目名 リクエストパラメータ 省略値
ユーザー名 userName 文字列 完全一致  
ロール名 userRoleName 文字列 完全一致  
ソート順 sort 文字列

"+パラメータ名" | "-パラメータ名"

• +:昇順

• -:降順

複数のパラメータを指定する場合は「,」で区切ります。

+userName
ページ数 page 数値

0始まりで指定します。

ページ数が1の場合、0を指定します。

0
1ページ当たりの項目数 size 数値   10
ソート順に指定できるパラメータ
項目名 パラメータ名

ユーザーID

userId
ユーザー名 userName
ロールID userRole.userRoleId
ロール名 userRole.userRoleName
レスポンス

{

"content": [

   {

   "passwdCreated": true,

   "userId": "string",

   "userName": "string",

   "userRoleId": "string"

   "userRoleName": "string"

   }

],

"first": true,

"last": true,

"number": 0,

"numberOfElements": 0,

"size": 0,

"sort": [],

"totalElements": 0,

"totalPages": 0

}

レスポンスパラメータ

content階層下のパラメータについては、「ユーザー詳細取得」「レスポンスパラメータ」を参照してください。

また、ページ設定のパラメータ(first, last, number, numberOfElements, size, sort, totalElements, totalPages)については、「ページ設定に関するレスポンスパラメータ」を参照してください。