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": "a607c225-c195-463e-ac08-94e8c9905447",
"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": "60df68b9-08a3-49fb-8353-3237d94de210",
"Teams": [
{
"TeamId": "754c038b-2656-4fc7-821e-6fde4c49be2f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "33b39660-80db-45aa-a37f-c3397281d29a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "25372586-1fd6-44c9-9f6f-dfbf8ea2dd41",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "33b39660-80db-45aa-a37f-c3397281d29a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "25372586-1fd6-44c9-9f6f-dfbf8ea2dd41",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7679c042-953e-4fbc-9b88-d0a59ea9ca47",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "754c038b-2656-4fc7-821e-6fde4c49be2f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "33b39660-80db-45aa-a37f-c3397281d29a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "25372586-1fd6-44c9-9f6f-dfbf8ea2dd41",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "33b39660-80db-45aa-a37f-c3397281d29a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "25372586-1fd6-44c9-9f6f-dfbf8ea2dd41",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7679c042-953e-4fbc-9b88-d0a59ea9ca47",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-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": "3245328c-09f8-432d-a765-b3e291d998cb",
"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": "43738219-07b3-4156-a469-2c0e16b41e88",
"Teams": [
{
"TeamId": "3cc3a03e-49f4-41aa-aa64-af1d9f77dac4",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e523478c-0af9-4a78-9a7d-f8f757c329b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2d3eef3c-533d-4099-87c5-6d7e93696900",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e523478c-0af9-4a78-9a7d-f8f757c329b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2d3eef3c-533d-4099-87c5-6d7e93696900",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "dbd6e9d2-f747-4550-89a7-d4a43778e278",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "3cc3a03e-49f4-41aa-aa64-af1d9f77dac4",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e523478c-0af9-4a78-9a7d-f8f757c329b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2d3eef3c-533d-4099-87c5-6d7e93696900",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e523478c-0af9-4a78-9a7d-f8f757c329b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"MeasurementValueNeededDate": "2025-12-03T21:25:36.2910373-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2d3eef3c-533d-4099-87c5-6d7e93696900",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "dbd6e9d2-f747-4550-89a7-d4a43778e278",
"CreateDate": "2025-12-03T21:25:36.2910373-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-03T21:25:36.2910373-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}