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": "c222b040-41b6-45bf-999b-3d6b9f0a0df4",
"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": "a2b4d2b7-2b73-4e4f-9944-fca7d5bf0efb",
"Teams": [
{
"TeamId": "b04c9342-4d11-4f69-b1f1-41e402a6d7c5",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0eb66d54-f318-4696-b8b8-7a0ef2b62b3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5e369e16-9bda-4b2d-b84e-46eb77d9f6ad",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0eb66d54-f318-4696-b8b8-7a0ef2b62b3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5e369e16-9bda-4b2d-b84e-46eb77d9f6ad",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "206b393f-a24b-4922-a417-fea79c5d9662",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b04c9342-4d11-4f69-b1f1-41e402a6d7c5",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0eb66d54-f318-4696-b8b8-7a0ef2b62b3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5e369e16-9bda-4b2d-b84e-46eb77d9f6ad",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0eb66d54-f318-4696-b8b8-7a0ef2b62b3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5e369e16-9bda-4b2d-b84e-46eb77d9f6ad",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "206b393f-a24b-4922-a417-fea79c5d9662",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-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": "af69266a-77ea-48b9-803b-b24a06e6a5f2",
"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": "8be9d9da-89de-4056-a32b-6d9618d92d4c",
"Teams": [
{
"TeamId": "d078d6e9-342e-427c-b15e-18b293c0677a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "237adf4f-8d61-4158-afba-00a08347e413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "66cbe1b3-845a-457b-97b4-c162e7578f6c",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "237adf4f-8d61-4158-afba-00a08347e413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "66cbe1b3-845a-457b-97b4-c162e7578f6c",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d9c014d0-911a-47f3-a9a5-17ef1837403e",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "d078d6e9-342e-427c-b15e-18b293c0677a",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "237adf4f-8d61-4158-afba-00a08347e413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "66cbe1b3-845a-457b-97b4-c162e7578f6c",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "237adf4f-8d61-4158-afba-00a08347e413",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"MeasurementValueNeededDate": "2025-11-28T09:05:14.4118016-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "66cbe1b3-845a-457b-97b4-c162e7578f6c",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d9c014d0-911a-47f3-a9a5-17ef1837403e",
"CreateDate": "2025-11-28T09:05:14.4118016-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-28T09:05:14.4118016-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}