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": "8525e855-7562-4c6e-99fe-41cba11e133c",
"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": "a6ee18e8-61e8-48b0-b04e-718d4287f86e",
"Teams": [
{
"TeamId": "ac6440ea-58b5-4a2a-aa24-e3c0ed0c0e57",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "cac9789c-d857-4b07-8f94-bf24afdf0063",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3992b1c-807d-450f-b90b-cbec408eab37",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "cac9789c-d857-4b07-8f94-bf24afdf0063",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3992b1c-807d-450f-b90b-cbec408eab37",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d19910e4-4eb3-4d5c-9848-1d5cf1d67583",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ac6440ea-58b5-4a2a-aa24-e3c0ed0c0e57",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "cac9789c-d857-4b07-8f94-bf24afdf0063",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3992b1c-807d-450f-b90b-cbec408eab37",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "cac9789c-d857-4b07-8f94-bf24afdf0063",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3992b1c-807d-450f-b90b-cbec408eab37",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d19910e4-4eb3-4d5c-9848-1d5cf1d67583",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-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": "537cf2e0-31eb-4e9d-94a7-2d4235a98de3",
"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": "ac941bbe-155e-4367-a92a-443e1a855459",
"Teams": [
{
"TeamId": "9a57f46f-4c72-4466-b738-acdffa6f287f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "7b558f78-134e-4cb1-87e0-33baff496e30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0fc4d70f-ccf8-4831-a3ae-14db32c4c656",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "7b558f78-134e-4cb1-87e0-33baff496e30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0fc4d70f-ccf8-4831-a3ae-14db32c4c656",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "3a5206e5-8be5-4a6b-9d94-1ef6e23722ac",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "9a57f46f-4c72-4466-b738-acdffa6f287f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "7b558f78-134e-4cb1-87e0-33baff496e30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0fc4d70f-ccf8-4831-a3ae-14db32c4c656",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "7b558f78-134e-4cb1-87e0-33baff496e30",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:40:03.4888755-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0fc4d70f-ccf8-4831-a3ae-14db32c4c656",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "3a5206e5-8be5-4a6b-9d94-1ef6e23722ac",
"CreateDate": "2026-06-28T09:40:03.4888755-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:40:03.4888755-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}