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": "07d915a1-c752-41f2-bbf7-08640532a6df",
"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": "0b6a037c-ba26-446d-acb2-49d2fcfad60c",
"Teams": [
{
"TeamId": "e16aaa84-6b78-49e7-86d3-1b8623c7cf37",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5f292744-08e6-4bb6-ad60-7a9f22315687",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "da2f7251-d458-439c-a7d0-a26fda6f2370",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5f292744-08e6-4bb6-ad60-7a9f22315687",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "da2f7251-d458-439c-a7d0-a26fda6f2370",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "557303f4-1c20-4ffa-a9b3-454637fe769f",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "e16aaa84-6b78-49e7-86d3-1b8623c7cf37",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5f292744-08e6-4bb6-ad60-7a9f22315687",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "da2f7251-d458-439c-a7d0-a26fda6f2370",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5f292744-08e6-4bb6-ad60-7a9f22315687",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "da2f7251-d458-439c-a7d0-a26fda6f2370",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "557303f4-1c20-4ffa-a9b3-454637fe769f",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-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": "a4fc8187-2ddc-4fee-a3f6-614489a8a5aa",
"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": "e47fa258-cdcd-4169-b491-98d9077a3cab",
"Teams": [
{
"TeamId": "f1f12ec4-e18a-4b12-bba7-d8f05c326304",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "2252c8db-ad9f-4f27-b173-2dac4c63e3c7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "babeb074-7daa-443c-ae7d-5ab57f705c58",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "2252c8db-ad9f-4f27-b173-2dac4c63e3c7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "babeb074-7daa-443c-ae7d-5ab57f705c58",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9ba888c6-4769-454c-a37f-4553602de871",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f1f12ec4-e18a-4b12-bba7-d8f05c326304",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "2252c8db-ad9f-4f27-b173-2dac4c63e3c7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "babeb074-7daa-443c-ae7d-5ab57f705c58",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "2252c8db-ad9f-4f27-b173-2dac4c63e3c7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:00:25.1630418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "babeb074-7daa-443c-ae7d-5ab57f705c58",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9ba888c6-4769-454c-a37f-4553602de871",
"CreateDate": "2026-03-15T18:00:25.1630418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:00:25.1630418-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}