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": "47ab382e-54e8-4a10-801e-13dbb1b392cc",
"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": "391e674f-bf8d-4192-a304-927f64f129a5",
"Teams": [
{
"TeamId": "94d92fa5-0c5a-4df1-aab0-c117f31c6d0c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "702797a4-db92-44c3-aa97-06fee2518dd4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "685486e8-eed6-407f-8264-314e773ab729",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "702797a4-db92-44c3-aa97-06fee2518dd4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "685486e8-eed6-407f-8264-314e773ab729",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "643745d9-8173-4f47-822c-32ec0c63f6c2",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "94d92fa5-0c5a-4df1-aab0-c117f31c6d0c",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "702797a4-db92-44c3-aa97-06fee2518dd4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "685486e8-eed6-407f-8264-314e773ab729",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "702797a4-db92-44c3-aa97-06fee2518dd4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "685486e8-eed6-407f-8264-314e773ab729",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "643745d9-8173-4f47-822c-32ec0c63f6c2",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-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": "5638bd46-c387-4772-af5a-2c9b8985d3fe",
"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": "dbe2cb27-fc5c-429f-bb93-b0030ce971b4",
"Teams": [
{
"TeamId": "4be930c3-5777-48e2-bbdf-3fefee8f5b3f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c4d730b3-6295-4889-ae08-5bbe6196d2d6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e334e6e0-888f-4ef9-b25a-6894a76e25b2",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c4d730b3-6295-4889-ae08-5bbe6196d2d6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e334e6e0-888f-4ef9-b25a-6894a76e25b2",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7aca6ae7-7b5c-45f9-867a-07a2c3a0c2f1",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "4be930c3-5777-48e2-bbdf-3fefee8f5b3f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c4d730b3-6295-4889-ae08-5bbe6196d2d6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e334e6e0-888f-4ef9-b25a-6894a76e25b2",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c4d730b3-6295-4889-ae08-5bbe6196d2d6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"MeasurementValueNeededDate": "2026-05-23T02:08:50.6955723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e334e6e0-888f-4ef9-b25a-6894a76e25b2",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7aca6ae7-7b5c-45f9-867a-07a2c3a0c2f1",
"CreateDate": "2026-05-23T02:08:50.6955723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T02:08:50.6955723-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}