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": "766d1cea-bee9-4567-baca-62283f6ee36f",
"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": "5f04c366-5404-4d01-adc1-ac6e20bfcbbf",
"Teams": [
{
"TeamId": "c0b04a55-70e8-4f3a-8980-4226ee7888d2",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "bde9edc6-c3e1-4129-a185-66b8250d23e8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9d38d4fb-532e-4625-80b4-28c408a00bb2",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "bde9edc6-c3e1-4129-a185-66b8250d23e8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9d38d4fb-532e-4625-80b4-28c408a00bb2",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f9692d6e-1bb1-4d56-ad7c-ba6e46121e6c",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "c0b04a55-70e8-4f3a-8980-4226ee7888d2",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "bde9edc6-c3e1-4129-a185-66b8250d23e8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9d38d4fb-532e-4625-80b4-28c408a00bb2",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "bde9edc6-c3e1-4129-a185-66b8250d23e8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9d38d4fb-532e-4625-80b4-28c408a00bb2",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f9692d6e-1bb1-4d56-ad7c-ba6e46121e6c",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-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": "5f1bac4d-4aba-41f7-b148-02ad5db338dd",
"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": "74c58526-b089-47ec-a852-c050edb274fe",
"Teams": [
{
"TeamId": "ee24877e-8885-4a0d-a933-94a0f9ca20ee",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "61de01ef-087b-4f40-8f5a-05fe2fafee15",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9be2b096-936f-47f1-8300-740c40b3e1cf",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "61de01ef-087b-4f40-8f5a-05fe2fafee15",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9be2b096-936f-47f1-8300-740c40b3e1cf",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7ad4410b-c86f-49cb-ac63-b09f2a2b8817",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ee24877e-8885-4a0d-a933-94a0f9ca20ee",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "61de01ef-087b-4f40-8f5a-05fe2fafee15",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9be2b096-936f-47f1-8300-740c40b3e1cf",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "61de01ef-087b-4f40-8f5a-05fe2fafee15",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"MeasurementValueNeededDate": "2026-08-29T21:48:39.0544071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9be2b096-936f-47f1-8300-740c40b3e1cf",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7ad4410b-c86f-49cb-ac63-b09f2a2b8817",
"CreateDate": "2026-08-29T21:48:39.0544071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:48:39.0544071-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}