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": "eba5bcf8-7bb1-41fb-8afc-a5b85d7e43a4",
"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": "52609fa3-843c-498b-80f8-83ec32b99b42",
"Teams": [
{
"TeamId": "831ea837-ff39-4b8d-a587-f2ecd119dcf6",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d20b77b8-b194-4437-8d9f-c3b290f83038",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "076335a3-e30b-4bde-b386-870545f612c4",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d20b77b8-b194-4437-8d9f-c3b290f83038",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "076335a3-e30b-4bde-b386-870545f612c4",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "59ca31fd-2d66-4678-9f1d-dba62f9d05d6",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "831ea837-ff39-4b8d-a587-f2ecd119dcf6",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d20b77b8-b194-4437-8d9f-c3b290f83038",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "076335a3-e30b-4bde-b386-870545f612c4",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d20b77b8-b194-4437-8d9f-c3b290f83038",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "076335a3-e30b-4bde-b386-870545f612c4",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "59ca31fd-2d66-4678-9f1d-dba62f9d05d6",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-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": "4ffc5283-00d3-4d1a-9794-0021887c99c6",
"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": "93aee40e-0417-49fc-a1cb-8dd1226e2234",
"Teams": [
{
"TeamId": "1aab6ea9-d33e-4086-b17b-bae6e2d60cc4",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c8909c6e-7707-4ab9-b8b7-7e15250c3202",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26d80c76-b9ad-460f-89fb-2cd1ecc1168e",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c8909c6e-7707-4ab9-b8b7-7e15250c3202",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26d80c76-b9ad-460f-89fb-2cd1ecc1168e",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7dc7cda0-9798-435f-b4cd-84dd97756bf6",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "1aab6ea9-d33e-4086-b17b-bae6e2d60cc4",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c8909c6e-7707-4ab9-b8b7-7e15250c3202",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26d80c76-b9ad-460f-89fb-2cd1ecc1168e",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c8909c6e-7707-4ab9-b8b7-7e15250c3202",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:41:53.6504018-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26d80c76-b9ad-460f-89fb-2cd1ecc1168e",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7dc7cda0-9798-435f-b4cd-84dd97756bf6",
"CreateDate": "2026-08-09T23:41:53.6504018-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:41:53.6504018-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}