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": "6589ec84-faea-43b0-bfa8-77b28a5bed71",
"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": "4496e931-f478-4892-9193-3c2e38e2e33d",
"Teams": [
{
"TeamId": "10b890c8-0425-48a8-a17e-c46aac1f8060",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "4d79a5a9-fc91-4e28-881e-f056afb11943",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e2b7081a-96f3-4bb0-843a-b318d879e515",
"CreateDate": "2026-07-22T02:07:12.3212045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3212045-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "4d79a5a9-fc91-4e28-881e-f056afb11943",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e2b7081a-96f3-4bb0-843a-b318d879e515",
"CreateDate": "2026-07-22T02:07:12.3212045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3212045-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "76f0013c-d47b-4c21-84aa-23694b534092",
"CreateDate": "2026-07-22T02:07:12.3212045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3212045-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "10b890c8-0425-48a8-a17e-c46aac1f8060",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "4d79a5a9-fc91-4e28-881e-f056afb11943",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e2b7081a-96f3-4bb0-843a-b318d879e515",
"CreateDate": "2026-07-22T02:07:12.3212045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3212045-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "4d79a5a9-fc91-4e28-881e-f056afb11943",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3212045-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e2b7081a-96f3-4bb0-843a-b318d879e515",
"CreateDate": "2026-07-22T02:07:12.3212045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3212045-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "76f0013c-d47b-4c21-84aa-23694b534092",
"CreateDate": "2026-07-22T02:07:12.3212045-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3212045-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": "c69fd23f-3f38-4f65-b588-ae5532441206",
"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": "136d52fb-8417-411b-bdda-293013115d34",
"Teams": [
{
"TeamId": "20cf656e-090d-4ecf-8476-745abbc5b67e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "6ee978ee-7175-4e94-b60e-2f959093faa6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "11740e11-e2d5-47a0-b9f9-a4a82e04da82",
"CreateDate": "2026-07-22T02:07:12.3368243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3368243-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "6ee978ee-7175-4e94-b60e-2f959093faa6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "11740e11-e2d5-47a0-b9f9-a4a82e04da82",
"CreateDate": "2026-07-22T02:07:12.3368243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3368243-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "8292e316-7c66-4246-a150-3953956ff6f6",
"CreateDate": "2026-07-22T02:07:12.3368243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3368243-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "20cf656e-090d-4ecf-8476-745abbc5b67e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "6ee978ee-7175-4e94-b60e-2f959093faa6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "11740e11-e2d5-47a0-b9f9-a4a82e04da82",
"CreateDate": "2026-07-22T02:07:12.3368243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3368243-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "6ee978ee-7175-4e94-b60e-2f959093faa6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"MeasurementValueNeededDate": "2026-07-22T02:07:12.3368243-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "11740e11-e2d5-47a0-b9f9-a4a82e04da82",
"CreateDate": "2026-07-22T02:07:12.3368243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3368243-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "8292e316-7c66-4246-a150-3953956ff6f6",
"CreateDate": "2026-07-22T02:07:12.3368243-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-22T02:07:12.3368243-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}