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": "6dc588cd-29d7-431e-be02-dfd898e19146",
"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": "fa463357-91ee-4f60-8975-8d9f37e965cc",
"Teams": [
{
"TeamId": "dbe5fe4b-820e-4291-8803-ef9c196fda65",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5704ca16-08f4-4079-bbc0-17e186340d1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "34e00ceb-4c77-44c6-9364-bae4318d0fc0",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5704ca16-08f4-4079-bbc0-17e186340d1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "34e00ceb-4c77-44c6-9364-bae4318d0fc0",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "88aa4f98-1ee3-4f13-98b2-615859fc23b5",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "dbe5fe4b-820e-4291-8803-ef9c196fda65",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5704ca16-08f4-4079-bbc0-17e186340d1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "34e00ceb-4c77-44c6-9364-bae4318d0fc0",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5704ca16-08f4-4079-bbc0-17e186340d1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "34e00ceb-4c77-44c6-9364-bae4318d0fc0",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "88aa4f98-1ee3-4f13-98b2-615859fc23b5",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-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": "fe9221e9-9704-48c9-91e0-2008654f65e3",
"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": "76b25b9e-6860-4e2e-8cbc-0d52f75e00ce",
"Teams": [
{
"TeamId": "f2475847-aea0-4b24-a183-26cca7b8c52b",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "dab23698-c2e7-48ba-b9b6-abd7ddb80851",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "becad14b-7b74-4d0e-b968-ece66eaafe24",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "dab23698-c2e7-48ba-b9b6-abd7ddb80851",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "becad14b-7b74-4d0e-b968-ece66eaafe24",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1e8a0778-0f76-41f7-b597-d50e5f88c020",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f2475847-aea0-4b24-a183-26cca7b8c52b",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "dab23698-c2e7-48ba-b9b6-abd7ddb80851",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "becad14b-7b74-4d0e-b968-ece66eaafe24",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "dab23698-c2e7-48ba-b9b6-abd7ddb80851",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"MeasurementValueNeededDate": "2026-09-06T01:46:03.3572092-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "becad14b-7b74-4d0e-b968-ece66eaafe24",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1e8a0778-0f76-41f7-b597-d50e5f88c020",
"CreateDate": "2026-09-06T01:46:03.3572092-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-06T01:46:03.3572092-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}