Skip to main content
POST
Pageable User Listing Operation

Body

application/json
roles
enum<string>[]

User Roles Filter

{msg:swagger.schema.users.page-request.roles}

Available options:
GUEST,
API_USER,
STANDARD_USER,
POWER_USER,
EXTENDED_USER,
ADMIN
Example:

"['API_USER', 'STANDARD_USER']"

status
enum<string>[]

User Statuses Filter

{msg:swagger.schema.users.page-request.status}

Available options:
INACTIVE,
ACTIVE,
EXPIRED,
BLOCKED,
DELETED
Example:

"['INACTIVE', 'BLOCKED', 'EXPIRED']"

sortBy
object

Result Sorting Fields and Directions

Example:
pageNumber
integer<int32>

Page Number

Required range: x >= 0
Example:

0

pageSize
integer<int32>

Number of Records in the Page

Required range: 1 <= x <= 100
Example:

10

includeAccount
boolean

Include Account Details Flag

Example:

false

Response

Successful User Listing

users
object[]

User List on the Page

totalRecords
integer<int32>

Total Number of Users

pageNumber
integer<int32>

Page Number

pageSize
integer<int32>

Number of Records in the Page