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": "dd8887d6-e664-489d-ae07-3a41df55ef7e",
"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": "a9a7e265-6df3-4261-8efa-bd7adb998072",
"Teams": [
{
"TeamId": "2ab4f647-4e8a-4367-abc2-70da4b9a77c6",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "40bcafd9-e362-4f1d-8c48-635d71c7d7d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f834e302-b06a-4c1e-acd5-a243bd33e188",
"CreateDate": "2026-07-15T00:33:29.0873121-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.0873121-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "40bcafd9-e362-4f1d-8c48-635d71c7d7d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f834e302-b06a-4c1e-acd5-a243bd33e188",
"CreateDate": "2026-07-15T00:33:29.0873121-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.0873121-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "49ec43c9-cd83-4fad-8aad-3461d907a177",
"CreateDate": "2026-07-15T00:33:29.0873121-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.0873121-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "2ab4f647-4e8a-4367-abc2-70da4b9a77c6",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "40bcafd9-e362-4f1d-8c48-635d71c7d7d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f834e302-b06a-4c1e-acd5-a243bd33e188",
"CreateDate": "2026-07-15T00:33:29.0873121-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.0873121-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "40bcafd9-e362-4f1d-8c48-635d71c7d7d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.0873121-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f834e302-b06a-4c1e-acd5-a243bd33e188",
"CreateDate": "2026-07-15T00:33:29.0873121-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.0873121-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "49ec43c9-cd83-4fad-8aad-3461d907a177",
"CreateDate": "2026-07-15T00:33:29.0873121-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.0873121-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": "6b9773d6-439c-4269-abe1-7d65d8120ffb",
"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": "8924e6d6-21c7-4f78-9f66-4823930a26b7",
"Teams": [
{
"TeamId": "b71dd248-93e8-42c1-926c-863f8e6db64c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ef41dd43-d266-4672-8f4f-66512ab82804",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b3f4757-68ac-4eda-bd79-80047f7310df",
"CreateDate": "2026-07-15T00:33:29.1029195-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.1029195-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ef41dd43-d266-4672-8f4f-66512ab82804",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b3f4757-68ac-4eda-bd79-80047f7310df",
"CreateDate": "2026-07-15T00:33:29.1029195-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.1029195-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a2eba2e1-3a0b-4428-83d1-52461a44ddf4",
"CreateDate": "2026-07-15T00:33:29.1029195-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.1029195-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b71dd248-93e8-42c1-926c-863f8e6db64c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ef41dd43-d266-4672-8f4f-66512ab82804",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b3f4757-68ac-4eda-bd79-80047f7310df",
"CreateDate": "2026-07-15T00:33:29.1029195-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.1029195-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ef41dd43-d266-4672-8f4f-66512ab82804",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"MeasurementValueNeededDate": "2026-07-15T00:33:29.1029195-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8b3f4757-68ac-4eda-bd79-80047f7310df",
"CreateDate": "2026-07-15T00:33:29.1029195-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.1029195-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a2eba2e1-3a0b-4428-83d1-52461a44ddf4",
"CreateDate": "2026-07-15T00:33:29.1029195-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T00:33:29.1029195-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}