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": "71f07dfd-7eaa-40d5-9284-7350743856f3",
"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": "ea7487ba-62a9-42c7-ae91-15301e828390",
"Teams": [
{
"TeamId": "6845b4d7-0d21-4079-ad7d-68d2b899afea",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0afc5891-4496-4b5a-b13e-89042c7a8b17",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a44f9851-e34e-44ac-852a-a5ec1e1b8b9f",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0afc5891-4496-4b5a-b13e-89042c7a8b17",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a44f9851-e34e-44ac-852a-a5ec1e1b8b9f",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "489c3d54-eb69-444f-924f-850ba8ac228a",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "6845b4d7-0d21-4079-ad7d-68d2b899afea",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0afc5891-4496-4b5a-b13e-89042c7a8b17",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a44f9851-e34e-44ac-852a-a5ec1e1b8b9f",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0afc5891-4496-4b5a-b13e-89042c7a8b17",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a44f9851-e34e-44ac-852a-a5ec1e1b8b9f",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "489c3d54-eb69-444f-924f-850ba8ac228a",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-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": "9e5b001e-5ab0-4c92-8a28-e21aa028cb83",
"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": "07c0e0e5-8847-491f-9fa7-5d05da3e1633",
"Teams": [
{
"TeamId": "53b6b54c-88e5-486d-b39c-f1ddbf4ad0e7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "9eb079d5-a969-48e7-b52e-251a893e8697",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5982c5a-067d-4afd-beb3-3218b13d0276",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "9eb079d5-a969-48e7-b52e-251a893e8697",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5982c5a-067d-4afd-beb3-3218b13d0276",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "35885472-52b2-4503-b4c2-813d4d2e7c4d",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "53b6b54c-88e5-486d-b39c-f1ddbf4ad0e7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "9eb079d5-a969-48e7-b52e-251a893e8697",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5982c5a-067d-4afd-beb3-3218b13d0276",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "9eb079d5-a969-48e7-b52e-251a893e8697",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:26:06.289718-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5982c5a-067d-4afd-beb3-3218b13d0276",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "35885472-52b2-4503-b4c2-813d4d2e7c4d",
"CreateDate": "2026-06-25T14:26:06.289718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:06.289718-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}