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": "45a41703-98a8-4861-8ab1-9c3431b19139",
"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": "5125802b-3ed7-4a8e-97f4-4062f1addd1a",
"Teams": [
{
"TeamId": "b76395f1-9d68-4741-a8ac-4e4e9e05abf1",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ba759057-f9f6-4848-a0f7-c9a1a6144dac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "322febba-d3ea-4d9c-8bb3-b85a6b8a60de",
"CreateDate": "2026-01-24T20:29:44.8655161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.8655161-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ba759057-f9f6-4848-a0f7-c9a1a6144dac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "322febba-d3ea-4d9c-8bb3-b85a6b8a60de",
"CreateDate": "2026-01-24T20:29:44.8655161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.8655161-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a2e31e14-eb10-4452-abcd-9e50bcc2dcfb",
"CreateDate": "2026-01-24T20:29:44.8655161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.8655161-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b76395f1-9d68-4741-a8ac-4e4e9e05abf1",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ba759057-f9f6-4848-a0f7-c9a1a6144dac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "322febba-d3ea-4d9c-8bb3-b85a6b8a60de",
"CreateDate": "2026-01-24T20:29:44.8655161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.8655161-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ba759057-f9f6-4848-a0f7-c9a1a6144dac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.8655161-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "322febba-d3ea-4d9c-8bb3-b85a6b8a60de",
"CreateDate": "2026-01-24T20:29:44.8655161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.8655161-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a2e31e14-eb10-4452-abcd-9e50bcc2dcfb",
"CreateDate": "2026-01-24T20:29:44.8655161-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.8655161-08: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": "8bb4bf67-a228-4ebd-8b52-24891a71a12f",
"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": "0b9e3911-7836-441a-9a35-a0cc2e41c806",
"Teams": [
{
"TeamId": "e9608e78-f77f-47fc-9fc3-d5f266d2d810",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "2c8ebe71-6cd2-4959-aa6a-00dd26255b5d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "abf787bd-f0aa-4fee-a436-1193ae1029c4",
"CreateDate": "2026-01-24T20:29:44.881079-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.881079-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "2c8ebe71-6cd2-4959-aa6a-00dd26255b5d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "abf787bd-f0aa-4fee-a436-1193ae1029c4",
"CreateDate": "2026-01-24T20:29:44.881079-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.881079-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f4318b0d-950f-4fb0-a253-73c7fba0eb20",
"CreateDate": "2026-01-24T20:29:44.881079-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.881079-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "e9608e78-f77f-47fc-9fc3-d5f266d2d810",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "2c8ebe71-6cd2-4959-aa6a-00dd26255b5d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "abf787bd-f0aa-4fee-a436-1193ae1029c4",
"CreateDate": "2026-01-24T20:29:44.881079-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.881079-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "2c8ebe71-6cd2-4959-aa6a-00dd26255b5d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"MeasurementValueNeededDate": "2026-01-24T20:29:44.881079-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "abf787bd-f0aa-4fee-a436-1193ae1029c4",
"CreateDate": "2026-01-24T20:29:44.881079-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.881079-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f4318b0d-950f-4fb0-a253-73c7fba0eb20",
"CreateDate": "2026-01-24T20:29:44.881079-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T20:29:44.881079-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}