POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
UserName | 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": "aa4cf82f-9676-4965-9820-a96420c7b76c", "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": "6a357175-40fa-4c00-b9ad-c651ccc7b48a", "Teams": [ { "TeamId": "77d59561-3ce2-4717-a1c7-a7ec6195b7c2", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1d05fbc2-415f-4078-a877-c1ce9fb1f992", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e6548944-5d3c-4016-9834-2255af7780d6", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1d05fbc2-415f-4078-a877-c1ce9fb1f992", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e6548944-5d3c-4016-9834-2255af7780d6", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "627306c2-1432-4f9d-a076-3012eebc6d25", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "77d59561-3ce2-4717-a1c7-a7ec6195b7c2", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1d05fbc2-415f-4078-a877-c1ce9fb1f992", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e6548944-5d3c-4016-9834-2255af7780d6", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1d05fbc2-415f-4078-a877-c1ce9fb1f992", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e6548944-5d3c-4016-9834-2255af7780d6", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "627306c2-1432-4f9d-a076-3012eebc6d25", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-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": "b310ad8f-a882-4fe4-b6c1-95a2afc86b5f", "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": "5e71b68d-89cd-4dd4-959d-e630cbe7ba51", "Teams": [ { "TeamId": "733aece3-aaa8-40f8-a5e8-53a82a9c6a70", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e5940ebb-39c5-4823-b3d1-f637a060f006", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b4697325-df35-4d7f-bff8-a96edfe9633b", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e5940ebb-39c5-4823-b3d1-f637a060f006", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b4697325-df35-4d7f-bff8-a96edfe9633b", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "bc7bb8aa-904c-4484-add8-3c6c8d38a771", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "733aece3-aaa8-40f8-a5e8-53a82a9c6a70", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e5940ebb-39c5-4823-b3d1-f637a060f006", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b4697325-df35-4d7f-bff8-a96edfe9633b", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e5940ebb-39c5-4823-b3d1-f637a060f006", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "MeasurementValueNeededDate": "2025-10-13T19:38:13.9777785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b4697325-df35-4d7f-bff8-a96edfe9633b", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "bc7bb8aa-904c-4484-add8-3c6c8d38a771", "CreateDate": "2025-10-13T19:38:13.9777785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T19:38:13.9777785-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }