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": "54d9be5c-3c25-4e21-831b-972febb14cb1",
"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": "a6449393-78dc-48f6-9949-37b6e7615c2e",
"Teams": [
{
"TeamId": "d43a18cc-8e78-4a83-8519-3f1a6c684916",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "9b7ed47c-884f-42d4-8332-fd7f8a7ff617",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "812792ed-5e65-48af-82b5-34a217169fe6",
"CreateDate": "2026-03-24T01:46:58.5113112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5113112-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "9b7ed47c-884f-42d4-8332-fd7f8a7ff617",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "812792ed-5e65-48af-82b5-34a217169fe6",
"CreateDate": "2026-03-24T01:46:58.5113112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5113112-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b7b715cd-fa05-4e3b-9f42-f68c7e7a84e8",
"CreateDate": "2026-03-24T01:46:58.5113112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5113112-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "d43a18cc-8e78-4a83-8519-3f1a6c684916",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "9b7ed47c-884f-42d4-8332-fd7f8a7ff617",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "812792ed-5e65-48af-82b5-34a217169fe6",
"CreateDate": "2026-03-24T01:46:58.5113112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5113112-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "9b7ed47c-884f-42d4-8332-fd7f8a7ff617",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5113112-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "812792ed-5e65-48af-82b5-34a217169fe6",
"CreateDate": "2026-03-24T01:46:58.5113112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5113112-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b7b715cd-fa05-4e3b-9f42-f68c7e7a84e8",
"CreateDate": "2026-03-24T01:46:58.5113112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5113112-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": "dd88b94b-39cc-46bd-b09a-055196385450",
"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": "bf1ee080-117a-4690-86cd-cd7ee000df5c",
"Teams": [
{
"TeamId": "5be59ff5-d823-481a-a81a-f975aba2b840",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d12854b6-563b-4cb9-8ef3-4f9787d16c4e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "334a1738-517e-4baa-800d-e2ac06727f3c",
"CreateDate": "2026-03-24T01:46:58.5270025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5270025-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d12854b6-563b-4cb9-8ef3-4f9787d16c4e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "334a1738-517e-4baa-800d-e2ac06727f3c",
"CreateDate": "2026-03-24T01:46:58.5270025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5270025-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "fdf6a3a5-fc89-41a0-ad45-87097f45f9dd",
"CreateDate": "2026-03-24T01:46:58.5270025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5270025-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "5be59ff5-d823-481a-a81a-f975aba2b840",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d12854b6-563b-4cb9-8ef3-4f9787d16c4e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "334a1738-517e-4baa-800d-e2ac06727f3c",
"CreateDate": "2026-03-24T01:46:58.5270025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5270025-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d12854b6-563b-4cb9-8ef3-4f9787d16c4e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"MeasurementValueNeededDate": "2026-03-24T01:46:58.5270025-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "334a1738-517e-4baa-800d-e2ac06727f3c",
"CreateDate": "2026-03-24T01:46:58.5270025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5270025-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "fdf6a3a5-fc89-41a0-ad45-87097f45f9dd",
"CreateDate": "2026-03-24T01:46:58.5270025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T01:46:58.5270025-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}