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": "8176bf7c-5daf-456a-9a7d-cf5d477cd638",
"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": "eb1d5beb-7f6b-449f-8394-404d409df106",
"Teams": [
{
"TeamId": "f3e0fdee-7f0b-4145-a59f-d21267912651",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f4dc95ca-5c6d-4766-b34e-95775ef5d264",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2efbaa47-5380-4b4f-a656-faeb1c7101b2",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f4dc95ca-5c6d-4766-b34e-95775ef5d264",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2efbaa47-5380-4b4f-a656-faeb1c7101b2",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b576b534-49fb-4acd-8a7c-cfa9d843536f",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f3e0fdee-7f0b-4145-a59f-d21267912651",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f4dc95ca-5c6d-4766-b34e-95775ef5d264",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2efbaa47-5380-4b4f-a656-faeb1c7101b2",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f4dc95ca-5c6d-4766-b34e-95775ef5d264",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2efbaa47-5380-4b4f-a656-faeb1c7101b2",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b576b534-49fb-4acd-8a7c-cfa9d843536f",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-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": "657b30f8-b0f1-494c-8866-b26affafefbb",
"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": "3d70dba7-f35d-4b6f-bfc2-4f0e2bd63861",
"Teams": [
{
"TeamId": "5942f3ba-f685-4824-9412-834fac3c0821",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a09047b6-6d76-496a-b96a-e508605ade57",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8942d2d-58ce-49c0-8eaa-8e53120fe5ff",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a09047b6-6d76-496a-b96a-e508605ade57",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8942d2d-58ce-49c0-8eaa-8e53120fe5ff",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5eb2bff6-0240-48ac-a754-2b4f6f725bef",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "5942f3ba-f685-4824-9412-834fac3c0821",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a09047b6-6d76-496a-b96a-e508605ade57",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8942d2d-58ce-49c0-8eaa-8e53120fe5ff",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a09047b6-6d76-496a-b96a-e508605ade57",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"MeasurementValueNeededDate": "2026-09-02T07:53:18.8456086-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8942d2d-58ce-49c0-8eaa-8e53120fe5ff",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5eb2bff6-0240-48ac-a754-2b4f6f725bef",
"CreateDate": "2026-09-02T07:53:18.8456086-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T07:53:18.8456086-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}