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": "f0e39c6c-21e6-4260-8821-971093f7a347",
"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": "d634c3aa-ecde-4dee-8298-79dd0011a240",
"Teams": [
{
"TeamId": "b8ccf557-1dc8-4b54-a4b8-e37b72288012",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "6d2d34f8-8fea-4619-8ca8-4dd9649ebd16",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "379291e2-662d-451c-b351-4d1d760d5d95",
"CreateDate": "2026-11-01T07:50:15.7742288-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.7742288-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "6d2d34f8-8fea-4619-8ca8-4dd9649ebd16",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "379291e2-662d-451c-b351-4d1d760d5d95",
"CreateDate": "2026-11-01T07:50:15.7742288-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.7742288-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6cb2472d-e078-4205-98df-0e3e5c3e3c30",
"CreateDate": "2026-11-01T07:50:15.7742288-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.7742288-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b8ccf557-1dc8-4b54-a4b8-e37b72288012",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "6d2d34f8-8fea-4619-8ca8-4dd9649ebd16",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "379291e2-662d-451c-b351-4d1d760d5d95",
"CreateDate": "2026-11-01T07:50:15.7742288-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.7742288-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "6d2d34f8-8fea-4619-8ca8-4dd9649ebd16",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.7742288-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "379291e2-662d-451c-b351-4d1d760d5d95",
"CreateDate": "2026-11-01T07:50:15.7742288-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.7742288-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6cb2472d-e078-4205-98df-0e3e5c3e3c30",
"CreateDate": "2026-11-01T07:50:15.7742288-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.7742288-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": "5797dd35-0075-47a5-81f3-e5ab4464e434",
"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": "833236b3-67d5-47f0-8523-f3c778054db7",
"Teams": [
{
"TeamId": "0c4de4de-50a0-481c-8dbe-05ceca22eae6",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "dca17629-c330-4987-ac42-a36c3f3932af",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bbac2014-6caa-4b93-8df5-c8dbf00393d9",
"CreateDate": "2026-11-01T07:50:15.789852-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.789852-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "dca17629-c330-4987-ac42-a36c3f3932af",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bbac2014-6caa-4b93-8df5-c8dbf00393d9",
"CreateDate": "2026-11-01T07:50:15.789852-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.789852-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "398f4a9b-7bff-4edb-bb6d-bc7f954e55c1",
"CreateDate": "2026-11-01T07:50:15.789852-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.789852-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "0c4de4de-50a0-481c-8dbe-05ceca22eae6",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "dca17629-c330-4987-ac42-a36c3f3932af",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bbac2014-6caa-4b93-8df5-c8dbf00393d9",
"CreateDate": "2026-11-01T07:50:15.789852-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.789852-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "dca17629-c330-4987-ac42-a36c3f3932af",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"MeasurementValueNeededDate": "2026-11-01T07:50:15.789852-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bbac2014-6caa-4b93-8df5-c8dbf00393d9",
"CreateDate": "2026-11-01T07:50:15.789852-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.789852-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "398f4a9b-7bff-4edb-bb6d-bc7f954e55c1",
"CreateDate": "2026-11-01T07:50:15.789852-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T07:50:15.789852-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}