UserDto¶
Example Json Object
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "email": "string",
10 "userName": "string",
11 "firstName": "string",
12 "lastName": "string",
13 "displayName": "string",
14 "permissions": "string",
15 "internalId": "string",
16 "preferredCulture": {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "name": "string",
25 "code": "string",
26 "defaultCulture": true,
27 "enable": true
28 },
29 "userGroups": [
30 {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "name": "string",
39 "description": "string",
40 "internalId": "string"
41 }
42 ],
43 "partnerIds": [
44 0
45 ],
46 "partners": [
47 {
48 "id": 0,
49 "status": "CREATED",
50 "displayId": "string",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "name": "string",
54 "fax": "string",
55 "phone": "string",
56 "parentId": 0,
57 "parentName": "string",
58 "parentDisplayId": "string",
59 "companyId": 0,
60 "partnerRoleId": 0,
61 "partnerContactId": 0
62 }
63 ]
64}
📄 Description: Data transfer object representing a user profile within the system, encompassing essential attributes such as user identification, contact information, and role specifications to facilitate user management and access control.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
createdBy |
string |
false |
none |
Username of who created this resource |
lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
createdDate |
string(date-time) |
false |
none |
Date of the created |
lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
archived |
boolean |
false |
none |
Indicates whether the user account has been archived, reflecting its inactive status within the system. |
externalId |
string |
false |
none |
Unique identifier for the external |
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
string |
true |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
userName |
string |
true |
none |
Name of the user |
firstName |
string |
true |
none |
Name of the first |
lastName |
string |
true |
none |
Name of the last |
displayName |
string |
false |
none |
Display name for user interface |
permissions |
string |
false |
none |
Specifies the access rights and privileges assigned to the user within the system. |
internalId |
string |
false |
none |
Unique identifier for the internal |
preferredCulture |
false |
none |
Indicates the user’s preferred cultural context for personalized content and interactions within the application. |
|
userGroups |
false |
none |
An array of user groups associated with the user, facilitating role-based access and permissions within the application. |
|
partnerIds |
[integer] |
false |
none |
List of unique identifiers for partners associated with the user, facilitating streamlined collaboration and management of partner relationships. |
partners |
false |
none |
An array of associated partners, represented as UserDto objects, that facilitates collaboration and resource sharing within the business ecosystem. |