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": "a0c7e912-5de2-4672-be79-7bead4b1f19a",
"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": "67fd83cb-477a-465c-a30e-a8ae50856548",
"Teams": [
{
"TeamId": "cc5ede7b-cdc1-4315-9521-73feee9ae5b2",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a0d26e64-64aa-4aa4-818c-6ce8d8c12cc8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfa2bcd0-b922-467e-b2f4-e82f47da27b4",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a0d26e64-64aa-4aa4-818c-6ce8d8c12cc8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfa2bcd0-b922-467e-b2f4-e82f47da27b4",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "4aea9288-bb43-42d9-8915-545d74169533",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "cc5ede7b-cdc1-4315-9521-73feee9ae5b2",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a0d26e64-64aa-4aa4-818c-6ce8d8c12cc8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfa2bcd0-b922-467e-b2f4-e82f47da27b4",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a0d26e64-64aa-4aa4-818c-6ce8d8c12cc8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfa2bcd0-b922-467e-b2f4-e82f47da27b4",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "4aea9288-bb43-42d9-8915-545d74169533",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-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": "e4020918-61cf-4db5-bde4-cb650cc9d195",
"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": "df0ae6a4-6792-4832-9e0f-e4df8efdd745",
"Teams": [
{
"TeamId": "7e08897d-09b7-4f1d-9533-55d631107866",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b09091c8-b6fb-46dc-ba6e-5a93aa3b97b1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b32caeb-4c35-4ba3-a680-3d3de2aceacb",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b09091c8-b6fb-46dc-ba6e-5a93aa3b97b1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b32caeb-4c35-4ba3-a680-3d3de2aceacb",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "17652b88-37ae-4606-a10e-4f81d12ed560",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "7e08897d-09b7-4f1d-9533-55d631107866",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b09091c8-b6fb-46dc-ba6e-5a93aa3b97b1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b32caeb-4c35-4ba3-a680-3d3de2aceacb",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b09091c8-b6fb-46dc-ba6e-5a93aa3b97b1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"MeasurementValueNeededDate": "2026-11-11T15:44:57.8227643-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b32caeb-4c35-4ba3-a680-3d3de2aceacb",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "17652b88-37ae-4606-a10e-4f81d12ed560",
"CreateDate": "2026-11-11T15:44:57.8227643-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-11T15:44:57.8227643-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}