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": "629cc61a-5831-43df-a4b2-f92854b96990", "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": "39149008-86ae-486d-b6fe-522f8fef4a4d", "Teams": [ { "TeamId": "c21b7b99-afe6-4465-91d3-c3faffe5def8", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "f9977481-f263-4f49-a175-92504d650ac3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1cbfb9c9-9956-465a-bcb7-f838bb0af6da", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "f9977481-f263-4f49-a175-92504d650ac3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1cbfb9c9-9956-465a-bcb7-f838bb0af6da", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0350d0cd-91d7-4031-a547-3e11e0006f34", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "c21b7b99-afe6-4465-91d3-c3faffe5def8", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "f9977481-f263-4f49-a175-92504d650ac3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1cbfb9c9-9956-465a-bcb7-f838bb0af6da", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "f9977481-f263-4f49-a175-92504d650ac3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1cbfb9c9-9956-465a-bcb7-f838bb0af6da", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0350d0cd-91d7-4031-a547-3e11e0006f34", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-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": "ef36badd-1c8b-4bb2-a55d-5790793ce76e", "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": "e8c46b3b-14a2-404c-a8c6-a5fa6b6395c5", "Teams": [ { "TeamId": "d239af1e-dc67-4313-a73b-67198def0a6e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "58bcbc9c-515b-4d90-941a-d5f7a267232d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5e4bc2b1-6e9e-41d8-8811-f3df8f613e77", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "58bcbc9c-515b-4d90-941a-d5f7a267232d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5e4bc2b1-6e9e-41d8-8811-f3df8f613e77", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "529f15f1-5acb-434d-8262-6ecc5e2b38dd", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d239af1e-dc67-4313-a73b-67198def0a6e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "58bcbc9c-515b-4d90-941a-d5f7a267232d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5e4bc2b1-6e9e-41d8-8811-f3df8f613e77", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "58bcbc9c-515b-4d90-941a-d5f7a267232d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:10.5890876-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5e4bc2b1-6e9e-41d8-8811-f3df8f613e77", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "529f15f1-5acb-434d-8262-6ecc5e2b38dd", "CreateDate": "2025-06-02T14:50:10.5890876-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:10.5890876-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }