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": "7ad75886-4645-4b8d-b3b2-7d42e12f776b",
"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": "a1523727-a9a6-4f33-9dca-d576601fcc43",
"Teams": [
{
"TeamId": "9ad3044e-135f-4e83-8c0f-1d54a8fe9609",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "60b4495b-d1fb-4106-9d37-82169394e868",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e546cb1-efa5-444d-9a3f-eb25a8bf9d7b",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "60b4495b-d1fb-4106-9d37-82169394e868",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e546cb1-efa5-444d-9a3f-eb25a8bf9d7b",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c9cc6f9b-2d8c-42f6-bfab-f4461f7a9cef",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "9ad3044e-135f-4e83-8c0f-1d54a8fe9609",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "60b4495b-d1fb-4106-9d37-82169394e868",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e546cb1-efa5-444d-9a3f-eb25a8bf9d7b",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "60b4495b-d1fb-4106-9d37-82169394e868",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2e546cb1-efa5-444d-9a3f-eb25a8bf9d7b",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c9cc6f9b-2d8c-42f6-bfab-f4461f7a9cef",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-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": "9e598706-db34-43bd-b3c0-77479aefcba6",
"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": "abb299ea-3055-4828-93e8-c8106b03c84c",
"Teams": [
{
"TeamId": "9b927f9a-9704-4ddf-a172-a67394ce6a2c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5f9e1ab8-a914-4e9b-b92f-be8e54a820f3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d4df6592-2156-489d-b939-545d32e80346",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5f9e1ab8-a914-4e9b-b92f-be8e54a820f3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d4df6592-2156-489d-b939-545d32e80346",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "cfa94aef-d173-40d5-97aa-0aa50963f8a0",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "9b927f9a-9704-4ddf-a172-a67394ce6a2c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5f9e1ab8-a914-4e9b-b92f-be8e54a820f3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d4df6592-2156-489d-b939-545d32e80346",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5f9e1ab8-a914-4e9b-b92f-be8e54a820f3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"MeasurementValueNeededDate": "2026-10-04T14:38:02.282205-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d4df6592-2156-489d-b939-545d32e80346",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "cfa94aef-d173-40d5-97aa-0aa50963f8a0",
"CreateDate": "2026-10-04T14:38:02.282205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T14:38:02.282205-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}