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": "0615a270-4354-47b6-8a2f-17b129f60723",
"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": "8b0553fa-601d-4d68-8777-aa4dfb7f1a85",
"Teams": [
{
"TeamId": "5da17b95-b90c-44e2-8afc-93819138bce1",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "8388e1fc-fe37-4f44-b271-f28f9bba3e21",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a526dbd-d9e7-49aa-8edb-a660776e3378",
"CreateDate": "2025-12-21T04:48:36.1584086-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1584086-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "8388e1fc-fe37-4f44-b271-f28f9bba3e21",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a526dbd-d9e7-49aa-8edb-a660776e3378",
"CreateDate": "2025-12-21T04:48:36.1584086-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1584086-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e941c864-10f7-4aee-afa6-19d73b4c00ed",
"CreateDate": "2025-12-21T04:48:36.1584086-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1584086-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "5da17b95-b90c-44e2-8afc-93819138bce1",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "8388e1fc-fe37-4f44-b271-f28f9bba3e21",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a526dbd-d9e7-49aa-8edb-a660776e3378",
"CreateDate": "2025-12-21T04:48:36.1584086-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1584086-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "8388e1fc-fe37-4f44-b271-f28f9bba3e21",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1584086-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7a526dbd-d9e7-49aa-8edb-a660776e3378",
"CreateDate": "2025-12-21T04:48:36.1584086-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1584086-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e941c864-10f7-4aee-afa6-19d73b4c00ed",
"CreateDate": "2025-12-21T04:48:36.1584086-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1584086-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": "ac2b41ee-4281-4c92-9cf6-6099b04218df",
"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": "3319cebc-6ded-4d67-a0e3-6d2454ded6d1",
"Teams": [
{
"TeamId": "39b7de64-dda8-4600-b484-24dc4cab96be",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b8457b08-92f7-4018-bad4-6389f582b1d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b8b7a2b4-7b14-4c51-9361-eada8de4217d",
"CreateDate": "2025-12-21T04:48:36.1739734-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1739734-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b8457b08-92f7-4018-bad4-6389f582b1d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b8b7a2b4-7b14-4c51-9361-eada8de4217d",
"CreateDate": "2025-12-21T04:48:36.1739734-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1739734-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "79eb99b1-081d-4dcc-9bd6-f07ef65dfd41",
"CreateDate": "2025-12-21T04:48:36.1739734-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1739734-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "39b7de64-dda8-4600-b484-24dc4cab96be",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b8457b08-92f7-4018-bad4-6389f582b1d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b8b7a2b4-7b14-4c51-9361-eada8de4217d",
"CreateDate": "2025-12-21T04:48:36.1739734-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1739734-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b8457b08-92f7-4018-bad4-6389f582b1d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:48:36.1739734-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b8b7a2b4-7b14-4c51-9361-eada8de4217d",
"CreateDate": "2025-12-21T04:48:36.1739734-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1739734-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "79eb99b1-081d-4dcc-9bd6-f07ef65dfd41",
"CreateDate": "2025-12-21T04:48:36.1739734-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:48:36.1739734-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}