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": "96e81213-7464-4a04-85f0-ff731820acf1",
"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": "836ee6cd-df5c-4261-abac-6565a9aa0698",
"Teams": [
{
"TeamId": "00750b51-2299-4784-ad23-985da34412dd",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "26c4bb4a-fe78-4f58-b094-a8c3dc7942ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dfc76a66-2d32-4f44-8000-bf340e0b2b20",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "26c4bb4a-fe78-4f58-b094-a8c3dc7942ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dfc76a66-2d32-4f44-8000-bf340e0b2b20",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a9fe3b38-efb1-4410-9cd5-380a4dec2867",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "00750b51-2299-4784-ad23-985da34412dd",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "26c4bb4a-fe78-4f58-b094-a8c3dc7942ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dfc76a66-2d32-4f44-8000-bf340e0b2b20",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "26c4bb4a-fe78-4f58-b094-a8c3dc7942ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dfc76a66-2d32-4f44-8000-bf340e0b2b20",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a9fe3b38-efb1-4410-9cd5-380a4dec2867",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-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": "c08b289b-cb96-4e7e-b965-ff8f4614e850",
"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": "c34f3188-44cb-4819-907e-a22e334b728e",
"Teams": [
{
"TeamId": "4c8b3584-d64f-4e00-9ad7-f79a53b19231",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5c197986-28a4-4492-b890-ce976575c857",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cc6f7a6d-e300-4480-98c7-84605e1816cc",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5c197986-28a4-4492-b890-ce976575c857",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cc6f7a6d-e300-4480-98c7-84605e1816cc",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6806d781-7e7e-4259-bdf9-d3ddda579c5d",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "4c8b3584-d64f-4e00-9ad7-f79a53b19231",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "5c197986-28a4-4492-b890-ce976575c857",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cc6f7a6d-e300-4480-98c7-84605e1816cc",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "5c197986-28a4-4492-b890-ce976575c857",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"MeasurementValueNeededDate": "2026-06-20T07:01:58.595785-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cc6f7a6d-e300-4480-98c7-84605e1816cc",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6806d781-7e7e-4259-bdf9-d3ddda579c5d",
"CreateDate": "2026-06-20T07:01:58.595785-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-20T07:01:58.595785-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}