|
Http Verb |
GET |
|
Url |
/configurations/identity/r3/user-types |
|
Permissions required |
User’s types: View user’s type (foundation.base.userType.view) User’s types: Edit user’s type (foundation.base.userType.edit) |
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
|
|
Released since |
2026 W3 (Foundation 14.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE |
Business Logic
This API returns a list of User Types filtered by input criteria.
Query String Parameters
Filter ℹ️
|
Field |
Validations |
Note |
|---|---|---|
|
id |
|
Collection of Ids |
|
code |
|
|
|
description |
|
|
|
active |
|
|
|
systemAdmin |
|
|
|
companyAdmin |
|
|
|
profileId |
|
|
Order ℹ️
Default Order
id (ASC)
Possible order values
id (ASC/DESC), code (ASC/DESC), description (ASC/DESC), isActive (ASC/DESC), systemAdmin (ASC/DESC), tenantAdmin (ASC/DESC)
Page ℹ️
Default.
Fields ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
|
|
code |
|
|
description |
|
|
ordering |
|
|
maxInactiveInterval |
|
|
active |
|
|
systemAdmin |
|
|
companyAdmin |
|
|
profileId |
|
Response error codes
UNAUTHORIZED, FORBIDDEN