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": "bdb15918-46df-4a4a-887a-c02132e96d58",
"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": "7ba4f493-ee6c-4eba-af12-644476c20ff6",
"Teams": [
{
"TeamId": "b7f21a50-0fe0-4661-8cab-1c5e7e3bb2fb",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f3781236-ed06-4792-8299-924262261448",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03ea1b6b-c909-47d4-8e16-ca0d2bf38345",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f3781236-ed06-4792-8299-924262261448",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03ea1b6b-c909-47d4-8e16-ca0d2bf38345",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5e502cee-ab4b-4609-ba7f-d79981de21a6",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b7f21a50-0fe0-4661-8cab-1c5e7e3bb2fb",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f3781236-ed06-4792-8299-924262261448",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03ea1b6b-c909-47d4-8e16-ca0d2bf38345",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f3781236-ed06-4792-8299-924262261448",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03ea1b6b-c909-47d4-8e16-ca0d2bf38345",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5e502cee-ab4b-4609-ba7f-d79981de21a6",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-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": "65ee62b0-33e6-4460-8044-ffcb6426dc52",
"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": "9f59c3e5-8bbd-49f7-8623-b3f4d01e3b8e",
"Teams": [
{
"TeamId": "89079f4e-6d16-47cd-9a5b-4c3dba3b299a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3b1cc91a-c665-4357-b2f9-9a2827d6efac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "38f8c187-9d98-422d-854f-2f607e51fd4d",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3b1cc91a-c665-4357-b2f9-9a2827d6efac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "38f8c187-9d98-422d-854f-2f607e51fd4d",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "792692d5-f0f2-4f9c-ae30-2b858221d889",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "89079f4e-6d16-47cd-9a5b-4c3dba3b299a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3b1cc91a-c665-4357-b2f9-9a2827d6efac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "38f8c187-9d98-422d-854f-2f607e51fd4d",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3b1cc91a-c665-4357-b2f9-9a2827d6efac",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"MeasurementValueNeededDate": "2026-08-01T19:51:14.294501-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "38f8c187-9d98-422d-854f-2f607e51fd4d",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "792692d5-f0f2-4f9c-ae30-2b858221d889",
"CreateDate": "2026-08-01T19:51:14.294501-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-01T19:51:14.294501-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}