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": "0ed4f437-053e-4fbf-adc6-7e747f08180a",
"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": "d1c8b1ce-8861-4964-bbd1-71bc9d11125f",
"Teams": [
{
"TeamId": "092993f0-5c9b-42f7-9a1b-991d6cb7d1f0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c8bfb222-cb44-4fc5-88c2-e4d8b298338a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4be27e1a-f3c9-48da-9dfb-2514b1a15015",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c8bfb222-cb44-4fc5-88c2-e4d8b298338a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4be27e1a-f3c9-48da-9dfb-2514b1a15015",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "34e6341b-e855-436f-8a86-eca99b823b9f",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "092993f0-5c9b-42f7-9a1b-991d6cb7d1f0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c8bfb222-cb44-4fc5-88c2-e4d8b298338a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4be27e1a-f3c9-48da-9dfb-2514b1a15015",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c8bfb222-cb44-4fc5-88c2-e4d8b298338a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4be27e1a-f3c9-48da-9dfb-2514b1a15015",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "34e6341b-e855-436f-8a86-eca99b823b9f",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-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": "df0c2f70-ecdd-42f0-83c4-7689022fd3fb",
"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": "b3a4e0db-62e5-44a4-a965-7733fdce989a",
"Teams": [
{
"TeamId": "1b5aeb9d-3536-4575-9b3c-36785e589ae3",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "147f797f-8551-4dd6-8300-842db9ea1fcb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "811b5095-6f89-46ca-8f6a-e64d609a5036",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "147f797f-8551-4dd6-8300-842db9ea1fcb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "811b5095-6f89-46ca-8f6a-e64d609a5036",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "8b471f59-2d1a-4301-94ae-59a9516a7041",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "1b5aeb9d-3536-4575-9b3c-36785e589ae3",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "147f797f-8551-4dd6-8300-842db9ea1fcb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "811b5095-6f89-46ca-8f6a-e64d609a5036",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "147f797f-8551-4dd6-8300-842db9ea1fcb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"MeasurementValueNeededDate": "2026-03-04T21:21:44.8734371-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "811b5095-6f89-46ca-8f6a-e64d609a5036",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "8b471f59-2d1a-4301-94ae-59a9516a7041",
"CreateDate": "2026-03-04T21:21:44.8734371-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T21:21:44.8734371-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}