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": "10cec5b2-83dc-471a-9231-34f7ebab98f6",
"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": "da26a049-9a7c-4fae-83ad-13f767cb7fd6",
"Teams": [
{
"TeamId": "b0b13135-f1e6-43b0-a5fb-4d388a643034",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a732c314-a01b-402b-bce8-d60d224bc859",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c95ddd6-fc2f-4f55-8d6e-00a17fb2b789",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a732c314-a01b-402b-bce8-d60d224bc859",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c95ddd6-fc2f-4f55-8d6e-00a17fb2b789",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "42935d7c-95e9-4c1e-8c68-53558401296d",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b0b13135-f1e6-43b0-a5fb-4d388a643034",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a732c314-a01b-402b-bce8-d60d224bc859",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c95ddd6-fc2f-4f55-8d6e-00a17fb2b789",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a732c314-a01b-402b-bce8-d60d224bc859",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c95ddd6-fc2f-4f55-8d6e-00a17fb2b789",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "42935d7c-95e9-4c1e-8c68-53558401296d",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-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": "10209dba-1b60-4efe-987b-255a8705e697",
"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": "2564889d-19b2-4a26-b9ae-59f9a441d9e3",
"Teams": [
{
"TeamId": "88a1101e-8f10-496a-8546-4c44202d2d91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e48fea15-4616-4ac6-98c8-f65ebb522ded",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "932fa414-0a00-406a-81bd-13ec28594335",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e48fea15-4616-4ac6-98c8-f65ebb522ded",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "932fa414-0a00-406a-81bd-13ec28594335",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "2cd2663b-d8a4-4b7a-905a-97f218be2024",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "88a1101e-8f10-496a-8546-4c44202d2d91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e48fea15-4616-4ac6-98c8-f65ebb522ded",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "932fa414-0a00-406a-81bd-13ec28594335",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e48fea15-4616-4ac6-98c8-f65ebb522ded",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"MeasurementValueNeededDate": "2026-04-28T16:47:13.7295329-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "932fa414-0a00-406a-81bd-13ec28594335",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "2cd2663b-d8a4-4b7a-905a-97f218be2024",
"CreateDate": "2026-04-28T16:47:13.7295329-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T16:47:13.7295329-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}