POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
User| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| UserName | string |
None. |
|
| FullName | string |
None. |
|
| PhoneNumber | string |
None. |
|
| string |
None. |
||
| IsLockedOut | boolean |
None. |
|
| IsApproved | boolean |
None. |
|
| Role | Role |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| Teams | Collection of Team |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "213d7650-b872-488b-9df6-41f725fdf372",
"UserName": "sample string 1",
"FullName": "sample string 2",
"PhoneNumber": "sample string 3",
"Email": "sample string 4",
"IsLockedOut": true,
"IsApproved": true,
"Role": {
"Name": "sample string 1",
"Description": "sample string 2"
},
"CompanyId": "0efbf363-6680-4c5b-8b4d-d613c4ba078b",
"Teams": [
{
"TeamId": "811ec3f9-7a38-453f-98a4-271442e28d4c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "073020a2-d33c-45b2-804e-0792656b8395",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae26e441-a515-40ed-8f84-7d8bc6397881",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "073020a2-d33c-45b2-804e-0792656b8395",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae26e441-a515-40ed-8f84-7d8bc6397881",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e4d8f6fe-22c4-4078-acaf-83459de8d21c",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "811ec3f9-7a38-453f-98a4-271442e28d4c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "073020a2-d33c-45b2-804e-0792656b8395",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae26e441-a515-40ed-8f84-7d8bc6397881",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "073020a2-d33c-45b2-804e-0792656b8395",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae26e441-a515-40ed-8f84-7d8bc6397881",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e4d8f6fe-22c4-4078-acaf-83459de8d21c",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
}
]
}
Response Information
Resource Description
On success, the created user.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | User |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"UserId": "4f3b820f-bd8b-4eaf-b743-c11941fd4177",
"UserName": "sample string 1",
"FullName": "sample string 2",
"PhoneNumber": "sample string 3",
"Email": "sample string 4",
"IsLockedOut": true,
"IsApproved": true,
"Role": {
"Name": "sample string 1",
"Description": "sample string 2"
},
"CompanyId": "dddea657-b1b3-4bee-89b9-4df77e77de2c",
"Teams": [
{
"TeamId": "ac30ab5b-4a02-433c-b7d9-bafac29020e7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "85a6be4d-ccb6-4c9c-84a1-9f274b28a32e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "90a3dd27-fbf8-4e0f-beac-f88ddadc6779",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "85a6be4d-ccb6-4c9c-84a1-9f274b28a32e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "90a3dd27-fbf8-4e0f-beac-f88ddadc6779",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7e04f991-5e43-4751-ac29-23092d120c80",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ac30ab5b-4a02-433c-b7d9-bafac29020e7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "85a6be4d-ccb6-4c9c-84a1-9f274b28a32e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "90a3dd27-fbf8-4e0f-beac-f88ddadc6779",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "85a6be4d-ccb6-4c9c-84a1-9f274b28a32e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"MeasurementValueNeededDate": "2026-07-18T16:30:57.7011919-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "90a3dd27-fbf8-4e0f-beac-f88ddadc6779",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7e04f991-5e43-4751-ac29-23092d120c80",
"CreateDate": "2026-07-18T16:30:57.7011919-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T16:30:57.7011919-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}