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": "138c1008-e12e-442c-8927-61b5eebbc59f",
"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": "48a0264c-b5a2-4b90-b259-c91f5b58976f",
"Teams": [
{
"TeamId": "9422f72a-ba92-4b8d-bdd2-fdcc2eca9140",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "46de3ce3-d226-4cf4-8d03-28a956f0394a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2bd90907-cecc-4322-b0e9-6d231253d9d4",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "46de3ce3-d226-4cf4-8d03-28a956f0394a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2bd90907-cecc-4322-b0e9-6d231253d9d4",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "48c6baee-6006-4a4f-affc-98f35dcf229b",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "9422f72a-ba92-4b8d-bdd2-fdcc2eca9140",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "46de3ce3-d226-4cf4-8d03-28a956f0394a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2bd90907-cecc-4322-b0e9-6d231253d9d4",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "46de3ce3-d226-4cf4-8d03-28a956f0394a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2bd90907-cecc-4322-b0e9-6d231253d9d4",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "48c6baee-6006-4a4f-affc-98f35dcf229b",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-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": "2ed6d794-4a84-46ad-aeaa-f8fcfa5f6576",
"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": "d7981f7f-8f86-42d8-ba4d-492c6111d728",
"Teams": [
{
"TeamId": "5f24bdbb-74fe-4c4b-889b-6d4ffce12e5f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b663d0ad-eeea-4642-a962-0a0d473ac290",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "219c1b05-2de1-408e-8fc0-291a90115c0b",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b663d0ad-eeea-4642-a962-0a0d473ac290",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "219c1b05-2de1-408e-8fc0-291a90115c0b",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c9ae7b5d-d4a7-4544-acae-f5bf91959ae1",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "5f24bdbb-74fe-4c4b-889b-6d4ffce12e5f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b663d0ad-eeea-4642-a962-0a0d473ac290",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "219c1b05-2de1-408e-8fc0-291a90115c0b",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b663d0ad-eeea-4642-a962-0a0d473ac290",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"MeasurementValueNeededDate": "2026-03-09T20:37:46.4962991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "219c1b05-2de1-408e-8fc0-291a90115c0b",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c9ae7b5d-d4a7-4544-acae-f5bf91959ae1",
"CreateDate": "2026-03-09T20:37:46.4962991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T20:37:46.4962991-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}