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": "34da1c97-ff39-4bc6-a7b1-8f960522eff0",
"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": "f7cc3193-0e7e-4bc6-9720-d34c32ce7ef6",
"Teams": [
{
"TeamId": "3bf7f572-e8b2-4bea-a305-f781fda4218d",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "60411a61-90e9-43dc-bbd2-4fbb51bd4324",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a47a99e-a52c-47b7-91e5-c73c40f7e800",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "60411a61-90e9-43dc-bbd2-4fbb51bd4324",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a47a99e-a52c-47b7-91e5-c73c40f7e800",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1db3df84-06f5-495c-87d8-4ce8a03eb687",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "3bf7f572-e8b2-4bea-a305-f781fda4218d",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "60411a61-90e9-43dc-bbd2-4fbb51bd4324",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a47a99e-a52c-47b7-91e5-c73c40f7e800",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "60411a61-90e9-43dc-bbd2-4fbb51bd4324",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a47a99e-a52c-47b7-91e5-c73c40f7e800",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1db3df84-06f5-495c-87d8-4ce8a03eb687",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-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": "c3726751-3d16-4655-b9c9-200beb021d37",
"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": "24e970fb-a432-4b6b-8821-21de0ed79da1",
"Teams": [
{
"TeamId": "5025c11c-2de0-4dcc-8217-720236288d88",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ae876293-b8ee-47fc-a239-de776e8ce49e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "00b6cb3f-be57-4782-a0a4-b263b553afcd",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ae876293-b8ee-47fc-a239-de776e8ce49e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "00b6cb3f-be57-4782-a0a4-b263b553afcd",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1c20bc5f-75e3-4b2e-a797-b5994851200a",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "5025c11c-2de0-4dcc-8217-720236288d88",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ae876293-b8ee-47fc-a239-de776e8ce49e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "00b6cb3f-be57-4782-a0a4-b263b553afcd",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ae876293-b8ee-47fc-a239-de776e8ce49e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:49:50.9556029-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "00b6cb3f-be57-4782-a0a4-b263b553afcd",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1c20bc5f-75e3-4b2e-a797-b5994851200a",
"CreateDate": "2026-03-30T16:49:50.9556029-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:49:50.9556029-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}