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": "68ddd30b-3647-4e4c-81bc-b0936817a9e6",
"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": "af46a463-86dc-47a0-81fb-12bbbfaf9f90",
"Teams": [
{
"TeamId": "0e062007-e8e4-4623-8b52-e91017146d09",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c107350f-9051-494d-bd3f-16df31c97874",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a2b2751-0101-4c2d-b46a-957b2f75be3d",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c107350f-9051-494d-bd3f-16df31c97874",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a2b2751-0101-4c2d-b46a-957b2f75be3d",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1d38d61c-aeb7-42b6-9ec0-c346a45517ca",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "0e062007-e8e4-4623-8b52-e91017146d09",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c107350f-9051-494d-bd3f-16df31c97874",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a2b2751-0101-4c2d-b46a-957b2f75be3d",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c107350f-9051-494d-bd3f-16df31c97874",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a2b2751-0101-4c2d-b46a-957b2f75be3d",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1d38d61c-aeb7-42b6-9ec0-c346a45517ca",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-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": "4b8a912f-65fd-442f-9181-4e96036b223f",
"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": "f5285d53-dd5b-49a0-bc92-eb255ee603a3",
"Teams": [
{
"TeamId": "8d89c556-a2ac-432c-88e8-d851124b64b2",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "8e4a4d02-e270-4bf8-b2a2-1c2a5ff88401",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5c3d04a-cdbb-45ae-95e9-743819498bda",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "8e4a4d02-e270-4bf8-b2a2-1c2a5ff88401",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5c3d04a-cdbb-45ae-95e9-743819498bda",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "89c48df6-f7c3-4139-9e10-ba8168a3335d",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "8d89c556-a2ac-432c-88e8-d851124b64b2",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "8e4a4d02-e270-4bf8-b2a2-1c2a5ff88401",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5c3d04a-cdbb-45ae-95e9-743819498bda",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "8e4a4d02-e270-4bf8-b2a2-1c2a5ff88401",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"MeasurementValueNeededDate": "2026-08-23T01:18:36.7426964-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5c3d04a-cdbb-45ae-95e9-743819498bda",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "89c48df6-f7c3-4139-9e10-ba8168a3335d",
"CreateDate": "2026-08-23T01:18:36.7426964-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T01:18:36.7426964-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}