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": "dcf512a2-28b4-4240-88bb-955c2cea10ce", "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": "9d3dc004-c5a4-479d-99b0-77f0b1eb14be", "Teams": [ { "TeamId": "9d70b638-dcc6-44a4-a41c-da87c3489c8a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "463980c8-57f1-44dc-909c-365920b88c4d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8b571ed3-d501-4785-bc02-94956fdb2c05", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "463980c8-57f1-44dc-909c-365920b88c4d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8b571ed3-d501-4785-bc02-94956fdb2c05", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "fe901a08-f726-4f57-93a9-d9ddc996f00b", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9d70b638-dcc6-44a4-a41c-da87c3489c8a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "463980c8-57f1-44dc-909c-365920b88c4d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8b571ed3-d501-4785-bc02-94956fdb2c05", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "463980c8-57f1-44dc-909c-365920b88c4d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8b571ed3-d501-4785-bc02-94956fdb2c05", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "fe901a08-f726-4f57-93a9-d9ddc996f00b", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-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": "631d0b59-48ee-4228-a7fb-2b469d5c551f", "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": "b4b132f6-dd4a-42b1-8af0-6ef200038803", "Teams": [ { "TeamId": "38454cfe-0ef4-47fe-8409-965fd8cc5399", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9866c249-61bd-4341-bf2d-98cf8d2bba8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bf7e31c9-b89d-4d01-8e7d-40370c991b79", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9866c249-61bd-4341-bf2d-98cf8d2bba8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bf7e31c9-b89d-4d01-8e7d-40370c991b79", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "398c61d1-a4ce-4f66-93f8-22909795f8c2", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "38454cfe-0ef4-47fe-8409-965fd8cc5399", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9866c249-61bd-4341-bf2d-98cf8d2bba8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bf7e31c9-b89d-4d01-8e7d-40370c991b79", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9866c249-61bd-4341-bf2d-98cf8d2bba8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:04.4348983-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bf7e31c9-b89d-4d01-8e7d-40370c991b79", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "398c61d1-a4ce-4f66-93f8-22909795f8c2", "CreateDate": "2025-08-30T12:59:04.4348983-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:04.4348983-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }