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": "29b78669-e194-42e0-9087-bbf6fdab616d",
"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": "2ec071a8-3004-4f23-855b-3f0837a70563",
"Teams": [
{
"TeamId": "a45f62e9-2b0d-433a-ab47-9f8b2dfeed5c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3f6a7257-c397-4ac5-8c33-1c402a9a2870",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0ab7c02a-8bb3-423c-a9b3-eea2faacd94a",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3f6a7257-c397-4ac5-8c33-1c402a9a2870",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0ab7c02a-8bb3-423c-a9b3-eea2faacd94a",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "aea7008e-8b04-4962-8ddb-7d646c5cb496",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "a45f62e9-2b0d-433a-ab47-9f8b2dfeed5c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3f6a7257-c397-4ac5-8c33-1c402a9a2870",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0ab7c02a-8bb3-423c-a9b3-eea2faacd94a",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3f6a7257-c397-4ac5-8c33-1c402a9a2870",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0ab7c02a-8bb3-423c-a9b3-eea2faacd94a",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "aea7008e-8b04-4962-8ddb-7d646c5cb496",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-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": "918c042f-b18b-47d9-a670-cc75388d4b4b",
"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": "fc345cdb-7bdd-46b7-a53d-78fd80c9c393",
"Teams": [
{
"TeamId": "fd8f63d2-d8ff-4b2b-af0b-dec9d5cfceae",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ee7e3cdb-314c-43f3-ae09-93e7d40fa306",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "10748ca2-7d5e-4f49-a511-4255801ccbd9",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ee7e3cdb-314c-43f3-ae09-93e7d40fa306",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "10748ca2-7d5e-4f49-a511-4255801ccbd9",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "0cfc8157-7ac0-4048-a7cd-6d589a897a14",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "fd8f63d2-d8ff-4b2b-af0b-dec9d5cfceae",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ee7e3cdb-314c-43f3-ae09-93e7d40fa306",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "10748ca2-7d5e-4f49-a511-4255801ccbd9",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ee7e3cdb-314c-43f3-ae09-93e7d40fa306",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"MeasurementValueNeededDate": "2026-10-21T15:07:39.5630885-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "10748ca2-7d5e-4f49-a511-4255801ccbd9",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "0cfc8157-7ac0-4048-a7cd-6d589a897a14",
"CreateDate": "2026-10-21T15:07:39.5630885-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-21T15:07:39.5630885-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}