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": "d849e3fd-a0a4-414f-8a49-3d6ca8adac31",
"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": "1c54472b-7502-4fb6-bc26-f08d561b7e8f",
"Teams": [
{
"TeamId": "3718b0f5-10fb-475d-af44-3ef044643ee7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0274f78e-d72e-4e4a-8c7b-1b9abecb64e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3fbcee4-6c94-4457-bc5f-020966e735aa",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0274f78e-d72e-4e4a-8c7b-1b9abecb64e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3fbcee4-6c94-4457-bc5f-020966e735aa",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e6d37759-9df4-4f1a-a32e-ffda7c6b1451",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "3718b0f5-10fb-475d-af44-3ef044643ee7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0274f78e-d72e-4e4a-8c7b-1b9abecb64e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3fbcee4-6c94-4457-bc5f-020966e735aa",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0274f78e-d72e-4e4a-8c7b-1b9abecb64e9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3fbcee4-6c94-4457-bc5f-020966e735aa",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e6d37759-9df4-4f1a-a32e-ffda7c6b1451",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-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": "1816ca00-8cda-4aea-bdaa-e4695d11379b",
"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": "3508d98c-9edc-4fee-9497-eee1b4ac1e9e",
"Teams": [
{
"TeamId": "ac3593ab-e24d-4568-8047-e1285533349c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "fb6c189a-4e7c-4ca4-93af-55906a81386b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30879cea-7849-4ada-ad05-9c93584d87ac",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "fb6c189a-4e7c-4ca4-93af-55906a81386b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30879cea-7849-4ada-ad05-9c93584d87ac",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "54516cde-ee30-4b94-a777-46c0356e450f",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ac3593ab-e24d-4568-8047-e1285533349c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "fb6c189a-4e7c-4ca4-93af-55906a81386b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30879cea-7849-4ada-ad05-9c93584d87ac",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "fb6c189a-4e7c-4ca4-93af-55906a81386b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:33:15.1869279-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30879cea-7849-4ada-ad05-9c93584d87ac",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "54516cde-ee30-4b94-a777-46c0356e450f",
"CreateDate": "2026-04-27T20:33:15.1869279-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:33:15.1869279-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}