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": "8ee8039a-0369-4a31-8e07-d8a3942ee487",
"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": "9d732345-23c2-4b5c-a635-4a28fbebdd81",
"Teams": [
{
"TeamId": "3b964860-534c-4006-8719-84021dca2909",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e5db47af-26fb-4f7f-9fce-05e7747514e4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "93baca8c-939b-4567-ba70-c65dd77e6651",
"CreateDate": "2026-07-25T15:22:14.3651612-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3651612-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e5db47af-26fb-4f7f-9fce-05e7747514e4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "93baca8c-939b-4567-ba70-c65dd77e6651",
"CreateDate": "2026-07-25T15:22:14.3651612-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3651612-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "ff788683-e029-4c4a-9bac-a5d538e9011a",
"CreateDate": "2026-07-25T15:22:14.3651612-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3651612-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "3b964860-534c-4006-8719-84021dca2909",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e5db47af-26fb-4f7f-9fce-05e7747514e4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "93baca8c-939b-4567-ba70-c65dd77e6651",
"CreateDate": "2026-07-25T15:22:14.3651612-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3651612-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e5db47af-26fb-4f7f-9fce-05e7747514e4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3651612-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "93baca8c-939b-4567-ba70-c65dd77e6651",
"CreateDate": "2026-07-25T15:22:14.3651612-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3651612-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "ff788683-e029-4c4a-9bac-a5d538e9011a",
"CreateDate": "2026-07-25T15:22:14.3651612-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3651612-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": "76337b79-97f0-4474-9d21-44108a20a408",
"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": "6ef6eebb-afad-4685-bd88-d2f0ec06cb1e",
"Teams": [
{
"TeamId": "3c6468d7-6a6f-4434-9adc-7fe8db05eb1c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "42bb05c7-55a3-4e25-baf3-35d53d7a63b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "98e37281-96cd-4b9b-80e4-95fb886485ab",
"CreateDate": "2026-07-25T15:22:14.3808426-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3808426-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "42bb05c7-55a3-4e25-baf3-35d53d7a63b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "98e37281-96cd-4b9b-80e4-95fb886485ab",
"CreateDate": "2026-07-25T15:22:14.3808426-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3808426-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e9b3bb98-3952-42d9-94bd-aa0f95d43b96",
"CreateDate": "2026-07-25T15:22:14.3808426-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3808426-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "3c6468d7-6a6f-4434-9adc-7fe8db05eb1c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "42bb05c7-55a3-4e25-baf3-35d53d7a63b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "98e37281-96cd-4b9b-80e4-95fb886485ab",
"CreateDate": "2026-07-25T15:22:14.3808426-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3808426-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "42bb05c7-55a3-4e25-baf3-35d53d7a63b8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"MeasurementValueNeededDate": "2026-07-25T15:22:14.3808426-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "98e37281-96cd-4b9b-80e4-95fb886485ab",
"CreateDate": "2026-07-25T15:22:14.3808426-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3808426-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e9b3bb98-3952-42d9-94bd-aa0f95d43b96",
"CreateDate": "2026-07-25T15:22:14.3808426-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T15:22:14.3808426-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}