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": "eccec0b7-8886-4fba-8208-cae7f712d993",
"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": "9f6239d4-07cf-4ed7-88af-4390e773e487",
"Teams": [
{
"TeamId": "ea102c4b-7a8c-4438-9eea-670bc2984b27",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "87cce512-7e8a-47a7-b131-e83406c09793",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9007bebf-b46f-430d-a1f7-8a8939d78e11",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "87cce512-7e8a-47a7-b131-e83406c09793",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9007bebf-b46f-430d-a1f7-8a8939d78e11",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "439a8aad-8775-4cfd-b7ba-28570ab24591",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "ea102c4b-7a8c-4438-9eea-670bc2984b27",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "87cce512-7e8a-47a7-b131-e83406c09793",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9007bebf-b46f-430d-a1f7-8a8939d78e11",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "87cce512-7e8a-47a7-b131-e83406c09793",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9007bebf-b46f-430d-a1f7-8a8939d78e11",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "439a8aad-8775-4cfd-b7ba-28570ab24591",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-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": "939c6252-5c83-440c-b6e7-f589088bca50",
"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": "ac036c50-cdb7-4678-8a60-8c08a0c5f343",
"Teams": [
{
"TeamId": "75a5adaa-0869-4178-9119-2c2a85f76635",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f883a3a9-82e4-4a0d-ab79-b5d3964ca7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e207be26-2e11-4ff5-b22c-4b450298308a",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f883a3a9-82e4-4a0d-ab79-b5d3964ca7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e207be26-2e11-4ff5-b22c-4b450298308a",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "4ca8315c-b528-4764-8dd6-585f2b27bce5",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "75a5adaa-0869-4178-9119-2c2a85f76635",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f883a3a9-82e4-4a0d-ab79-b5d3964ca7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e207be26-2e11-4ff5-b22c-4b450298308a",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f883a3a9-82e4-4a0d-ab79-b5d3964ca7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:24.827067-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e207be26-2e11-4ff5-b22c-4b450298308a",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "4ca8315c-b528-4764-8dd6-585f2b27bce5",
"CreateDate": "2026-11-21T15:32:24.827067-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.827067-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}