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": "304b643b-c62e-45a3-b4e4-4c7ab995d2a6",
"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": "5821982c-8cef-4fcc-b85f-96c48488f04b",
"Teams": [
{
"TeamId": "c5cf6838-f866-41a6-900d-636ae9b4835e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "72dad4f7-4645-41de-93c2-74dd1b562a10",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ecf2f3a0-a01d-4fc0-a1be-e91ef4d38619",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "72dad4f7-4645-41de-93c2-74dd1b562a10",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ecf2f3a0-a01d-4fc0-a1be-e91ef4d38619",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a8002889-c946-455c-b575-f8890abcbdd0",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "c5cf6838-f866-41a6-900d-636ae9b4835e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "72dad4f7-4645-41de-93c2-74dd1b562a10",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ecf2f3a0-a01d-4fc0-a1be-e91ef4d38619",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "72dad4f7-4645-41de-93c2-74dd1b562a10",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ecf2f3a0-a01d-4fc0-a1be-e91ef4d38619",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a8002889-c946-455c-b575-f8890abcbdd0",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-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": "cb60593d-605d-438c-8927-d1a48fc8f97a",
"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": "d5cd86b6-56e4-4e69-b24d-4bd2c9089eff",
"Teams": [
{
"TeamId": "931e6cb6-03ec-4117-bb59-bc9ddec97005",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "7a5aa763-27d3-4771-b904-b1d6227ba76c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a383aaff-6eae-480b-b580-3aa505064741",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "7a5aa763-27d3-4771-b904-b1d6227ba76c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a383aaff-6eae-480b-b580-3aa505064741",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9a0062cb-79e7-46da-8b73-1828187008be",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "931e6cb6-03ec-4117-bb59-bc9ddec97005",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "7a5aa763-27d3-4771-b904-b1d6227ba76c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a383aaff-6eae-480b-b580-3aa505064741",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "7a5aa763-27d3-4771-b904-b1d6227ba76c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"MeasurementValueNeededDate": "2026-01-18T18:57:23.4461267-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a383aaff-6eae-480b-b580-3aa505064741",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9a0062cb-79e7-46da-8b73-1828187008be",
"CreateDate": "2026-01-18T18:57:23.4461267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-18T18:57:23.4461267-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}