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": "5b6c9c42-91d0-47bb-aeaf-b1bd094ae02b",
"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": "fb1b51c9-7af1-46c8-98bf-26ed2c3844e6",
"Teams": [
{
"TeamId": "df43adf2-c458-4bff-8329-75bbcfca8f4e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "96f8544f-74e6-4dab-aa78-bb8e405d7aa1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7ed59174-2298-4134-a4f7-2ece7c049802",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "96f8544f-74e6-4dab-aa78-bb8e405d7aa1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7ed59174-2298-4134-a4f7-2ece7c049802",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f2f2e6cb-277d-48d0-934c-cca1ddc33c7a",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "df43adf2-c458-4bff-8329-75bbcfca8f4e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "96f8544f-74e6-4dab-aa78-bb8e405d7aa1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7ed59174-2298-4134-a4f7-2ece7c049802",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "96f8544f-74e6-4dab-aa78-bb8e405d7aa1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7ed59174-2298-4134-a4f7-2ece7c049802",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f2f2e6cb-277d-48d0-934c-cca1ddc33c7a",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-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": "b467da61-f571-4e93-9bf1-8a8f4b2b2ad7",
"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": "7bf0bc87-286e-4a96-bfeb-9f7dabee31f7",
"Teams": [
{
"TeamId": "75b3ce5a-be25-4f94-96c7-f0c4740499e8",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "30f1d1ea-ef5e-4aab-8e07-a7adf85be413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "69048200-beb7-47e7-871d-7aab285f312a",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "30f1d1ea-ef5e-4aab-8e07-a7adf85be413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "69048200-beb7-47e7-871d-7aab285f312a",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f9648151-e74e-45ff-a0a1-813a904bedb0",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "75b3ce5a-be25-4f94-96c7-f0c4740499e8",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "30f1d1ea-ef5e-4aab-8e07-a7adf85be413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "69048200-beb7-47e7-871d-7aab285f312a",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "30f1d1ea-ef5e-4aab-8e07-a7adf85be413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"MeasurementValueNeededDate": "2026-08-26T06:28:04.1666782-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "69048200-beb7-47e7-871d-7aab285f312a",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f9648151-e74e-45ff-a0a1-813a904bedb0",
"CreateDate": "2026-08-26T06:28:04.1666782-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T06:28:04.1666782-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}