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": "553a42b7-4903-4763-b9eb-169984f87b90",
"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": "c57fddfb-a9f5-4388-ae54-bb512864bf15",
"Teams": [
{
"TeamId": "03e83e84-41fd-4fa1-9906-2a5d820e8d65",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d8fdb88c-641b-4d79-8080-abee91abe30e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8eebf19d-64e7-4155-a176-d5b6da61cc18",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d8fdb88c-641b-4d79-8080-abee91abe30e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8eebf19d-64e7-4155-a176-d5b6da61cc18",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "40acbd1b-e367-4a29-af98-147da0362a42",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "03e83e84-41fd-4fa1-9906-2a5d820e8d65",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d8fdb88c-641b-4d79-8080-abee91abe30e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8eebf19d-64e7-4155-a176-d5b6da61cc18",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d8fdb88c-641b-4d79-8080-abee91abe30e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8eebf19d-64e7-4155-a176-d5b6da61cc18",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "40acbd1b-e367-4a29-af98-147da0362a42",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-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": "5be127e0-e140-484c-b6d4-93c090e37199",
"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": "5588bd3e-2a04-466d-9a3b-0216c9542b3d",
"Teams": [
{
"TeamId": "ed67ce57-090c-439b-a54e-c810bc22027e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "283f1366-8531-4e85-affd-f5bddc58061b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7282ccb7-7187-4432-afd7-5771b6137277",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "283f1366-8531-4e85-affd-f5bddc58061b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7282ccb7-7187-4432-afd7-5771b6137277",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "368079ef-7501-4170-8666-716d83ddd940",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ed67ce57-090c-439b-a54e-c810bc22027e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "283f1366-8531-4e85-affd-f5bddc58061b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7282ccb7-7187-4432-afd7-5771b6137277",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "283f1366-8531-4e85-affd-f5bddc58061b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:52.7843971-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7282ccb7-7187-4432-afd7-5771b6137277",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "368079ef-7501-4170-8666-716d83ddd940",
"CreateDate": "2026-11-22T14:12:52.7843971-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:52.7843971-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}