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": "6e8a3048-fb8b-4a91-8dcb-5f1e0c696609",
"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": "68b074d7-95c1-459c-a3c3-fd2844386cf6",
"Teams": [
{
"TeamId": "ec424abd-befe-4e35-adb8-6a9b0ae011f3",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a0e91fa1-dc3d-46a5-8b5f-bfc0cf048072",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d237d4e2-ac3a-46a9-a21c-dcdd22bd5e1a",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a0e91fa1-dc3d-46a5-8b5f-bfc0cf048072",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d237d4e2-ac3a-46a9-a21c-dcdd22bd5e1a",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d062dbff-aca2-4822-b5f1-902d5abe1865",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ec424abd-befe-4e35-adb8-6a9b0ae011f3",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a0e91fa1-dc3d-46a5-8b5f-bfc0cf048072",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d237d4e2-ac3a-46a9-a21c-dcdd22bd5e1a",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a0e91fa1-dc3d-46a5-8b5f-bfc0cf048072",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d237d4e2-ac3a-46a9-a21c-dcdd22bd5e1a",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d062dbff-aca2-4822-b5f1-902d5abe1865",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-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": "28d6c9b6-3f0c-484e-b05b-908071d06014",
"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": "48fca23e-b51a-4f6a-a799-017bebedddd1",
"Teams": [
{
"TeamId": "b028bdbd-944f-4727-8407-95aaae795877",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f43e789a-aa37-47ff-9a44-871fac8b2d69",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9808a90b-5915-4b51-9a28-c6169e2ebdff",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f43e789a-aa37-47ff-9a44-871fac8b2d69",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9808a90b-5915-4b51-9a28-c6169e2ebdff",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c79ecc22-456d-497a-967e-1af2d9075c41",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b028bdbd-944f-4727-8407-95aaae795877",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f43e789a-aa37-47ff-9a44-871fac8b2d69",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9808a90b-5915-4b51-9a28-c6169e2ebdff",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f43e789a-aa37-47ff-9a44-871fac8b2d69",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"MeasurementValueNeededDate": "2026-09-16T09:58:14.7263576-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9808a90b-5915-4b51-9a28-c6169e2ebdff",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c79ecc22-456d-497a-967e-1af2d9075c41",
"CreateDate": "2026-09-16T09:58:14.7263576-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-16T09:58:14.7263576-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}