Resource Fields
|
PII |
SI |
Field |
Description |
Format |
|---|---|---|---|---|
|
|
|
id |
The "id" refers to the identifier of a specific entity within the context of the API. It is automatically generated, does not change, and can only be accessed in read mode. It serves as a search filter to locate data based on a list of values. This field is also named “userId“ when used as path parameter. |
integer |
|
|
|
username |
The user’s username |
string |
|
|
|
name |
The user’s name |
string |
|
|
|
surname |
The user’s surname |
string |
|
|
|
|
The user’s email |
string |
|
|
|
companyId |
Identifier of the Company to which the user belongs to |
integer |
|
|
|
typeId |
Identifier of the user’s User Type. |
integer |
|
|
|
additionalRolesId |
List of identifiers of the Additional Roles assigned to the user |
Collection of integer |
|
|
|
theme |
Name of the UI theme selected by the user |
string |
|
|
|
accessFailed |
Number of invalid login attempts |
integer |
|
|
|
startDate |
Date from which the user is valid |
date |
|
|
|
endDate |
Expiry date of the user |
date |
|
|
|
lastAccess |
Last login date |
date |
|
|
|
lastPasswordEdit |
Last password change date |
date |
|
|
|
unlockDate |
Last unlock date. If the user has never been locked, this parameter will not be returned |
date |
|
|
|
unallowedOperations |
Flag indicating if the user can see the un-allowed menu entry |
boolean |
|
|
|
language |
The user’s language |
string |