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": "f1a2b1ab-fcb1-4005-a196-e93031c14a12",
"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": "d83220d0-41be-470d-b74a-1f7f108ead9b",
"Teams": [
{
"TeamId": "15d1a137-bdc3-4e3c-87f2-af30f96e803f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a79dda3e-538a-4dd2-9cec-bdb83d9836a6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c41f3bf4-184a-4b12-83e7-4abccc3dbdce",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a79dda3e-538a-4dd2-9cec-bdb83d9836a6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c41f3bf4-184a-4b12-83e7-4abccc3dbdce",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b71e1d52-9148-4183-91d3-247807bc7a92",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "15d1a137-bdc3-4e3c-87f2-af30f96e803f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a79dda3e-538a-4dd2-9cec-bdb83d9836a6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c41f3bf4-184a-4b12-83e7-4abccc3dbdce",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a79dda3e-538a-4dd2-9cec-bdb83d9836a6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c41f3bf4-184a-4b12-83e7-4abccc3dbdce",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b71e1d52-9148-4183-91d3-247807bc7a92",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-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": "3472ff58-70ca-4cef-9e45-f7714797dbd8",
"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": "38eef811-ad65-4ef1-82fb-816c9759d142",
"Teams": [
{
"TeamId": "3b13d41f-6a5c-4ad7-ab2e-482c0d69305e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0d987201-478d-4e26-b691-5350d70e0045",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "96b63d23-3a65-4cb9-a3c2-024fb8dc6edc",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0d987201-478d-4e26-b691-5350d70e0045",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "96b63d23-3a65-4cb9-a3c2-024fb8dc6edc",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6ccae286-060d-44e4-a826-7aae5624d847",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "3b13d41f-6a5c-4ad7-ab2e-482c0d69305e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0d987201-478d-4e26-b691-5350d70e0045",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "96b63d23-3a65-4cb9-a3c2-024fb8dc6edc",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0d987201-478d-4e26-b691-5350d70e0045",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"MeasurementValueNeededDate": "2026-11-04T15:14:16.1852945-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "96b63d23-3a65-4cb9-a3c2-024fb8dc6edc",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6ccae286-060d-44e4-a826-7aae5624d847",
"CreateDate": "2026-11-04T15:14:16.1852945-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-04T15:14:16.1852945-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}