Acquire a list of users

This is an API function to acquire a list of users. This API function corresponds to the operation on the screen that is displayed by clicking the [User] tab after selecting the [Security] on the operation screen of Manager.

= Remarks =

The response parameters under the content layer of this API function are the same as the response parameters of the acquire user details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/user?REQUESTINQUERYFORMAT'
Request parameter (Query format)
Item name Request parameter Type Value Default value
User Name userName String Exact match  
Role Name userRoleName String Exact match  
Sort Order sort String

"+parameter-name" | "-paramater-name"

•　+: Ascending order

•　-: Descending order

If you specify multiple parameters, divide values by a comma (,).

 +userName
Number of pages page Integer

Specify a number from zero.

If the number of pages is 1, specify 0.

 0
Number of items per page size Integer   10
Parameters that can be set to Sort Order
Item name Parameter name
User ID userId
User Name userName
Role ID userRole.userRoleId
Role Name userRole.userRoleName
Response
{
   "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
}
Response parameter

For details of the parameters under the content layer, see Response parameter described in Acquire user details.

Also, for details about the parameters for page settings (first, last, number, numberOfElements, size, sort, totalElements, totalPages), see Response parameters for page settings.