|
Http Verb |
GET |
|
Url |
/configurations/identity/r1/users |
|
Permissions required |
User’s: View users (foundation.base.user.view) |
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r2 - 2026 W1 (Foundation 13.2) r2 - 2026 W2 (FSM 23.0) |
|
Released since |
|
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE |
Business Logic
This API returns a list of Users filtered by input criteria.
Query String Parameters
Filter ℹ️
|
Field |
Validations |
Note |
|---|---|---|
|
ids |
|
Collection of Ids |
|
username |
|
|
|
name |
|
|
|
surname |
|
|
|
type |
|
identifier of the type whose the user belongs to |
|
additionalRoles |
|
set of identifiers of the additional roles whose the user belongs to |
|
onlyValid |
|
|
Order ℹ️
Default Order
id (ASC)
Possible order values
id (ASC/DESC), username (ASC/DESC), name (ASC/DESC), surname (ASC/DESC), type (ASC/DESC), onlyValid (ASC/DESC)
Page ℹ️
Default.
Fields ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Note |
|
|---|---|---|
|
id |
|
|
|
username |
|
|
|
name |
|
|
|
surname |
|
|
|
|
|
|
|
factory |
identifier of the factory whose the user belongs to |
|
|
type |
identifier of the type whose the user belongs to |
|
|
additionalRoles |
set of identifier of the additional roles whose the user belongs to |
|
|
theme |
|
|
|
accessFailed |
number of the invalid login attempts |
|
|
start |
|
|
|
end |
expiry date of the user |
|
|
lastAccess |
|
|
|
lastPasswordEdit |
|
|
|
unlockDate |
last unlock date. if the user has never been locked this parameter will not been return |
|
|
unallowedOperations |
boolean indicating if the user can or can not see the un-allowed menu entry |
|
|
language |
|
|
Response error codes
UNAUTHORIZED, FORBIDDEN