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": "9f9a64eb-5ec6-4fd5-8743-36f517a62ce3", "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": "a6f64459-612c-477d-ac1c-0490f1c38da0", "Teams": [ { "TeamId": "db35496b-aaf9-48ab-82dc-97947f7b083a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "09d4d86d-2744-4a9b-82d2-c5d71e1b3196", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1710ba25-9121-4508-968b-e83c8c60b766", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "09d4d86d-2744-4a9b-82d2-c5d71e1b3196", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1710ba25-9121-4508-968b-e83c8c60b766", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "97535a13-81d4-4f70-8624-1295aee9e40f", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "db35496b-aaf9-48ab-82dc-97947f7b083a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "09d4d86d-2744-4a9b-82d2-c5d71e1b3196", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1710ba25-9121-4508-968b-e83c8c60b766", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "09d4d86d-2744-4a9b-82d2-c5d71e1b3196", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1710ba25-9121-4508-968b-e83c8c60b766", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "97535a13-81d4-4f70-8624-1295aee9e40f", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-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": "5214ef56-7925-4e3a-bf66-2d32f8d83619", "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": "f9348dcc-e953-42eb-89eb-b0a22feccc96", "Teams": [ { "TeamId": "156208a7-6a73-484d-9162-b969ba9a438c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "467a39b0-1c21-4959-808d-ba715fe8cebf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "992bc258-43df-4acf-b846-127109e3271a", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "467a39b0-1c21-4959-808d-ba715fe8cebf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "992bc258-43df-4acf-b846-127109e3271a", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c74e9e8a-a6a5-4e44-9469-61d48104ad64", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "156208a7-6a73-484d-9162-b969ba9a438c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "467a39b0-1c21-4959-808d-ba715fe8cebf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "992bc258-43df-4acf-b846-127109e3271a", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "467a39b0-1c21-4959-808d-ba715fe8cebf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "MeasurementValueNeededDate": "2025-07-09T12:10:47.671577-07:00", "SourceSystemId": "sample string 3", "CompanyId": "992bc258-43df-4acf-b846-127109e3271a", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c74e9e8a-a6a5-4e44-9469-61d48104ad64", "CreateDate": "2025-07-09T12:10:47.671577-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T12:10:47.671577-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }