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": "cb104eac-4a1d-407a-8e61-7ca4ead794bf",
"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": "09080754-77e8-4411-832f-bce4288d3e6e",
"Teams": [
{
"TeamId": "846d33b9-f6cf-4059-978b-deb78117da9d",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "df2acaa1-59c6-4ab1-b90f-df77278dc61a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "64e6dc41-a26b-4caa-93a5-376a39d1ca41",
"CreateDate": "2026-05-09T02:07:01.4480293-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4480293-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "df2acaa1-59c6-4ab1-b90f-df77278dc61a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "64e6dc41-a26b-4caa-93a5-376a39d1ca41",
"CreateDate": "2026-05-09T02:07:01.4480293-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4480293-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "ec0bb5dd-82bf-47b4-beba-cf34bebf45c5",
"CreateDate": "2026-05-09T02:07:01.4480293-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4480293-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "846d33b9-f6cf-4059-978b-deb78117da9d",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "df2acaa1-59c6-4ab1-b90f-df77278dc61a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "64e6dc41-a26b-4caa-93a5-376a39d1ca41",
"CreateDate": "2026-05-09T02:07:01.4480293-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4480293-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "df2acaa1-59c6-4ab1-b90f-df77278dc61a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4480293-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "64e6dc41-a26b-4caa-93a5-376a39d1ca41",
"CreateDate": "2026-05-09T02:07:01.4480293-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4480293-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "ec0bb5dd-82bf-47b4-beba-cf34bebf45c5",
"CreateDate": "2026-05-09T02:07:01.4480293-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4480293-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": "fafd7667-ca68-485d-ab92-a616357e1d29",
"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": "1cd85608-8dd6-494a-bdf5-e91849db22b6",
"Teams": [
{
"TeamId": "0f9579a5-d91f-47c0-b389-776e311128e7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0d64eb5b-efee-4814-bbad-8f11efb97e61",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "771c07cf-4cc4-4ed4-8d1e-62589d544ded",
"CreateDate": "2026-05-09T02:07:01.4635811-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4635811-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0d64eb5b-efee-4814-bbad-8f11efb97e61",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "771c07cf-4cc4-4ed4-8d1e-62589d544ded",
"CreateDate": "2026-05-09T02:07:01.4635811-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4635811-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a0dd3096-b0cf-4750-9978-d6ba0ea9ceff",
"CreateDate": "2026-05-09T02:07:01.4635811-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4635811-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "0f9579a5-d91f-47c0-b389-776e311128e7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0d64eb5b-efee-4814-bbad-8f11efb97e61",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "771c07cf-4cc4-4ed4-8d1e-62589d544ded",
"CreateDate": "2026-05-09T02:07:01.4635811-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4635811-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0d64eb5b-efee-4814-bbad-8f11efb97e61",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"MeasurementValueNeededDate": "2026-05-09T02:07:01.4635811-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "771c07cf-4cc4-4ed4-8d1e-62589d544ded",
"CreateDate": "2026-05-09T02:07:01.4635811-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4635811-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a0dd3096-b0cf-4750-9978-d6ba0ea9ceff",
"CreateDate": "2026-05-09T02:07:01.4635811-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T02:07:01.4635811-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}