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": "67ba9f34-36cc-453e-821d-0df9a23cc605",
"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": "a38c3f8d-3ab5-44e1-8d4c-60b5a289eea7",
"Teams": [
{
"TeamId": "44a88254-bc16-4ded-a78c-712a3f5af81c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b561ddc1-f8df-445c-8112-5abf052741b7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9723a4d0-5583-4cf5-be4c-6fcbea1bded9",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b561ddc1-f8df-445c-8112-5abf052741b7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9723a4d0-5583-4cf5-be4c-6fcbea1bded9",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "445eff80-2c47-4dc5-bc8a-3f90594e3aa8",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "44a88254-bc16-4ded-a78c-712a3f5af81c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b561ddc1-f8df-445c-8112-5abf052741b7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9723a4d0-5583-4cf5-be4c-6fcbea1bded9",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b561ddc1-f8df-445c-8112-5abf052741b7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9723a4d0-5583-4cf5-be4c-6fcbea1bded9",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "445eff80-2c47-4dc5-bc8a-3f90594e3aa8",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-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": "423f5cc4-0137-456b-812b-19e5cce36792",
"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": "b2f5a60e-25ce-495c-b984-a871fdb25fd0",
"Teams": [
{
"TeamId": "b84cc968-1494-4359-a8db-58f6c62ad39a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0c5afde2-a2fe-4026-b7c4-7d8f81d0e7c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b0f2051-9ab7-4450-a6fe-30c2e738e323",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0c5afde2-a2fe-4026-b7c4-7d8f81d0e7c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b0f2051-9ab7-4450-a6fe-30c2e738e323",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f1a4d58f-6a4a-4482-bfc1-f7fb67ca3bd3",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b84cc968-1494-4359-a8db-58f6c62ad39a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0c5afde2-a2fe-4026-b7c4-7d8f81d0e7c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b0f2051-9ab7-4450-a6fe-30c2e738e323",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0c5afde2-a2fe-4026-b7c4-7d8f81d0e7c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"MeasurementValueNeededDate": "2026-06-02T19:35:00.6748018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b0f2051-9ab7-4450-a6fe-30c2e738e323",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f1a4d58f-6a4a-4482-bfc1-f7fb67ca3bd3",
"CreateDate": "2026-06-02T19:35:00.6748018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T19:35:00.6748018-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}