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": "6e7e6dea-f231-4cf0-859e-290d01e3815d",
"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": "1a74f96c-57fb-4273-9d9a-3b15f939625d",
"Teams": [
{
"TeamId": "a98844cf-ed02-4267-8c98-7cef8d5a3d82",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3864af07-eb31-4587-bcde-411347ef71d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3be77761-4cc2-44da-a463-7c5a1955aa9b",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3864af07-eb31-4587-bcde-411347ef71d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3be77761-4cc2-44da-a463-7c5a1955aa9b",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "535c9789-65d1-4656-af3d-fff9095a927b",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "a98844cf-ed02-4267-8c98-7cef8d5a3d82",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3864af07-eb31-4587-bcde-411347ef71d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3be77761-4cc2-44da-a463-7c5a1955aa9b",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3864af07-eb31-4587-bcde-411347ef71d8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3be77761-4cc2-44da-a463-7c5a1955aa9b",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "535c9789-65d1-4656-af3d-fff9095a927b",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-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": "d81820d9-b3cb-4b7a-9c90-6082a2f6d521",
"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": "62dbb07e-2fdb-45c0-8cbb-31a02fecd26d",
"Teams": [
{
"TeamId": "a9680378-d661-49a4-87ee-582237001b39",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "98acf13e-d481-4660-baf3-09a8f9f7425b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5d9e0c7d-8620-4124-b7ad-d01727a80d03",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "98acf13e-d481-4660-baf3-09a8f9f7425b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5d9e0c7d-8620-4124-b7ad-d01727a80d03",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "bd0563a8-c601-4f13-bb94-c065a26355f9",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "a9680378-d661-49a4-87ee-582237001b39",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "98acf13e-d481-4660-baf3-09a8f9f7425b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5d9e0c7d-8620-4124-b7ad-d01727a80d03",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "98acf13e-d481-4660-baf3-09a8f9f7425b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"MeasurementValueNeededDate": "2025-11-04T14:23:39.2436794-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5d9e0c7d-8620-4124-b7ad-d01727a80d03",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "bd0563a8-c601-4f13-bb94-c065a26355f9",
"CreateDate": "2025-11-04T14:23:39.2436794-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T14:23:39.2436794-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}