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": "b8a6b4c1-f7cf-48dc-9995-4a564d2c0be5",
"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": "ffafbc37-6979-4164-9b63-2f2deab485b0",
"Teams": [
{
"TeamId": "31feba27-73d2-40b8-8945-827259c605c9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f3e3c8f3-9518-465c-afb6-bacc79c48393",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3b9b711-a38f-4663-b69f-9f0816cf0710",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f3e3c8f3-9518-465c-afb6-bacc79c48393",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3b9b711-a38f-4663-b69f-9f0816cf0710",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "2d0f5012-12b7-479d-9564-5551f1c67211",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "31feba27-73d2-40b8-8945-827259c605c9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "f3e3c8f3-9518-465c-afb6-bacc79c48393",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3b9b711-a38f-4663-b69f-9f0816cf0710",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "f3e3c8f3-9518-465c-afb6-bacc79c48393",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e3b9b711-a38f-4663-b69f-9f0816cf0710",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "2d0f5012-12b7-479d-9564-5551f1c67211",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-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": "f80c33fb-3e45-467b-9a4b-429132296ede",
"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": "df8a147c-a894-4c10-867a-ea5c645aecc6",
"Teams": [
{
"TeamId": "902088c3-040f-4c7e-85b3-5f215dda4267",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a962a340-663a-4ebf-b5ed-1dd73ccda337",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df52f9d-caad-4eb8-a05c-e45fa1b614f3",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a962a340-663a-4ebf-b5ed-1dd73ccda337",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df52f9d-caad-4eb8-a05c-e45fa1b614f3",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f8bca3b5-0df1-4f77-8501-3d31ef9bb4a6",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "902088c3-040f-4c7e-85b3-5f215dda4267",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a962a340-663a-4ebf-b5ed-1dd73ccda337",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df52f9d-caad-4eb8-a05c-e45fa1b614f3",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a962a340-663a-4ebf-b5ed-1dd73ccda337",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:41.3773065-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df52f9d-caad-4eb8-a05c-e45fa1b614f3",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "f8bca3b5-0df1-4f77-8501-3d31ef9bb4a6",
"CreateDate": "2026-09-26T13:57:41.3773065-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:41.3773065-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}