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": "3ff411a6-82b7-4cc4-b29e-37f931d09049",
"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": "4808841d-b503-47ac-abd8-8b59ee6c66de",
"Teams": [
{
"TeamId": "63999d80-0af9-4fdb-8b90-8bf0c0f77456",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "79b0a4ea-8d99-4783-a3f5-452bdd9b2480",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acc53c24-d6e2-44de-9c49-0f199e31889a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "79b0a4ea-8d99-4783-a3f5-452bdd9b2480",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acc53c24-d6e2-44de-9c49-0f199e31889a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "723e41a7-dce7-4c34-8802-f1b9b43bee42",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "63999d80-0af9-4fdb-8b90-8bf0c0f77456",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "79b0a4ea-8d99-4783-a3f5-452bdd9b2480",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acc53c24-d6e2-44de-9c49-0f199e31889a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "79b0a4ea-8d99-4783-a3f5-452bdd9b2480",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "acc53c24-d6e2-44de-9c49-0f199e31889a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "723e41a7-dce7-4c34-8802-f1b9b43bee42",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08: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": "2047bfc4-17c3-42dc-9579-56451062ab39",
"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": "5b6ab0d8-e749-4fc2-9ef4-45ac3e7ff84b",
"Teams": [
{
"TeamId": "b8da6b43-6ed1-42ff-9afc-ea708411b7c5",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "16bbcdb4-70d6-431e-8e78-65a40c0eda84",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4099d839-28e1-4c72-985c-90debcf57a8a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "16bbcdb4-70d6-431e-8e78-65a40c0eda84",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4099d839-28e1-4c72-985c-90debcf57a8a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "59d43b9c-2367-4b53-9f84-f71c8f15a760",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b8da6b43-6ed1-42ff-9afc-ea708411b7c5",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "16bbcdb4-70d6-431e-8e78-65a40c0eda84",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4099d839-28e1-4c72-985c-90debcf57a8a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "16bbcdb4-70d6-431e-8e78-65a40c0eda84",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"MeasurementValueNeededDate": "2025-12-28T05:42:03.8736116-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4099d839-28e1-4c72-985c-90debcf57a8a",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "59d43b9c-2367-4b53-9f84-f71c8f15a760",
"CreateDate": "2025-12-28T05:42:03.8736116-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-28T05:42:03.8736116-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}