|
Http Verb |
GET |
|
Url |
/configurations/identity/r3/users |
|
Permissions required |
User’s: View users (foundation.base.user.view) |
|
Personally Identifiable Information (PII) |
Yes |
|
Sensitive Information |
No |
|
Last Modified Version |
|
|
Released since |
2026 W3 (Foundation 14.1) |
|
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 |
|---|---|---|
|
id |
|
Collection of Ids |
|
username |
|
|
|
name |
|
|
|
surname |
|
|
|
typeId |
|
|
|
additionalRoles |
|
|
|
onlyValid |
|
Flag to include only valid users |
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 |
|
|
|
|
|
companyId |
|
|
typeId |
|
|
additionalRolesId |
|
|
theme |
|
|
accessFailed |
|
|
startDate |
|
|
endDate |
|
|
lastAccess |
|
|
lastPasswordEdit |
|
|
unlockDate |
|
|
unallowedOperations |
|
|
language |
|
Response error codes
UNAUTHORIZED, FORBIDDEN