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": "dbff3490-9299-43f2-9fc3-f11e62b427e2",
"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": "758c2a79-78c4-48d4-abeb-f54174f6edcb",
"Teams": [
{
"TeamId": "2090c707-d842-4115-807c-c36256e60d39",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "19c908ba-609c-45dd-a5b8-02204bffb232",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "01932ca2-71e8-4164-819e-f451aea6f1fb",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "19c908ba-609c-45dd-a5b8-02204bffb232",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "01932ca2-71e8-4164-819e-f451aea6f1fb",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "ff62e830-b4e8-4101-b11b-e69e07e2d8d0",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "2090c707-d842-4115-807c-c36256e60d39",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "19c908ba-609c-45dd-a5b8-02204bffb232",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "01932ca2-71e8-4164-819e-f451aea6f1fb",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "19c908ba-609c-45dd-a5b8-02204bffb232",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "01932ca2-71e8-4164-819e-f451aea6f1fb",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "ff62e830-b4e8-4101-b11b-e69e07e2d8d0",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-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": "06a61d9a-9e84-4f3a-ad2a-0037d3dfc56f",
"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": "baa4802a-ae70-4547-b5c0-0f3afb892e32",
"Teams": [
{
"TeamId": "66ccd133-4c34-4679-98b9-0cfefa06e013",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "4f53b85d-aca0-42a9-b178-2376f0a5f732",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3405ca0-38b2-4e78-a275-49e71f931735",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "4f53b85d-aca0-42a9-b178-2376f0a5f732",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3405ca0-38b2-4e78-a275-49e71f931735",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c1c05539-63cf-423a-8ef7-9063464cbb81",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "66ccd133-4c34-4679-98b9-0cfefa06e013",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "4f53b85d-aca0-42a9-b178-2376f0a5f732",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3405ca0-38b2-4e78-a275-49e71f931735",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "4f53b85d-aca0-42a9-b178-2376f0a5f732",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"MeasurementValueNeededDate": "2026-11-18T16:54:47.5384902-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3405ca0-38b2-4e78-a275-49e71f931735",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c1c05539-63cf-423a-8ef7-9063464cbb81",
"CreateDate": "2026-11-18T16:54:47.5384902-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-18T16:54:47.5384902-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}