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": "df240105-ab52-46af-a312-7cb1b5258408",
"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": "8bac824c-caea-44f7-9c5e-75f215c6ed59",
"Teams": [
{
"TeamId": "6e83c4bf-71a5-4574-bc75-7f66c682ac8a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "321cf235-9a49-4c49-be0e-56d83e1f3964",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "47d3f672-acd1-458b-94a0-a6164e599961",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "321cf235-9a49-4c49-be0e-56d83e1f3964",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "47d3f672-acd1-458b-94a0-a6164e599961",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "2b8e5794-f840-4733-b5ce-971813bb7388",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "6e83c4bf-71a5-4574-bc75-7f66c682ac8a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "321cf235-9a49-4c49-be0e-56d83e1f3964",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "47d3f672-acd1-458b-94a0-a6164e599961",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "321cf235-9a49-4c49-be0e-56d83e1f3964",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "47d3f672-acd1-458b-94a0-a6164e599961",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "2b8e5794-f840-4733-b5ce-971813bb7388",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-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": "6904a454-cb71-4107-a23b-cc1703d5dcd3",
"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": "8ac76e3d-1cfb-4466-8caf-64271d673a7d",
"Teams": [
{
"TeamId": "a001c141-99e1-4ae5-897f-085824d8c350",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d3e4d6a0-3b33-44cd-978a-ece54af8ebe7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2651886-607f-465a-92ec-e16d8f3ae9e6",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d3e4d6a0-3b33-44cd-978a-ece54af8ebe7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2651886-607f-465a-92ec-e16d8f3ae9e6",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "fa28d5d2-c234-454e-999f-a86497e25202",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "a001c141-99e1-4ae5-897f-085824d8c350",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d3e4d6a0-3b33-44cd-978a-ece54af8ebe7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2651886-607f-465a-92ec-e16d8f3ae9e6",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d3e4d6a0-3b33-44cd-978a-ece54af8ebe7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"MeasurementValueNeededDate": "2026-01-21T16:04:09.1612837-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2651886-607f-465a-92ec-e16d8f3ae9e6",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "fa28d5d2-c234-454e-999f-a86497e25202",
"CreateDate": "2026-01-21T16:04:09.1612837-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T16:04:09.1612837-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}