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": "a3c1e1d3-8087-46e1-ab10-f5b1abf19788",
"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": "7bb4e869-807e-4bac-9be7-3268c755dee2",
"Teams": [
{
"TeamId": "fe8424b0-1b2c-43e3-bfac-96cbe0ffac91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3d494234-9a1a-4f5d-9f5c-40a75ee7f7f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8bf4ea4d-7f88-4574-a2cb-890949077762",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3d494234-9a1a-4f5d-9f5c-40a75ee7f7f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8bf4ea4d-7f88-4574-a2cb-890949077762",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "82c53891-12b7-4c6b-bc24-89a7ae603be0",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "fe8424b0-1b2c-43e3-bfac-96cbe0ffac91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3d494234-9a1a-4f5d-9f5c-40a75ee7f7f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8bf4ea4d-7f88-4574-a2cb-890949077762",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3d494234-9a1a-4f5d-9f5c-40a75ee7f7f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8bf4ea4d-7f88-4574-a2cb-890949077762",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "82c53891-12b7-4c6b-bc24-89a7ae603be0",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-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": "ce7e87f2-29bc-48ec-8ff9-dfe9b4ffaec6",
"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": "c2f67d1c-1ae6-484f-bde1-beae67fc400f",
"Teams": [
{
"TeamId": "4e5b78ee-96d0-40b6-8678-4118a76d88e9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "1376a0d6-0e89-4914-bf94-ff58acb7c1b5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02badc87-fdab-4480-82b6-fce4fb4613e4",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "1376a0d6-0e89-4914-bf94-ff58acb7c1b5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02badc87-fdab-4480-82b6-fce4fb4613e4",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a3156613-a9f2-4b92-bc58-0fcc30061732",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "4e5b78ee-96d0-40b6-8678-4118a76d88e9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "1376a0d6-0e89-4914-bf94-ff58acb7c1b5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02badc87-fdab-4480-82b6-fce4fb4613e4",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "1376a0d6-0e89-4914-bf94-ff58acb7c1b5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"MeasurementValueNeededDate": "2026-05-30T02:10:46.3940379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02badc87-fdab-4480-82b6-fce4fb4613e4",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a3156613-a9f2-4b92-bc58-0fcc30061732",
"CreateDate": "2026-05-30T02:10:46.3940379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T02:10:46.3940379-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}