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": "7d47e0d5-1775-47bb-b957-4b6d243b86d4", "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": "a189b844-35c0-43e4-9550-55fab07c5739", "Teams": [ { "TeamId": "e7bd593b-c3aa-4216-bda7-a7deac02b573", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1819c975-6cce-4081-88d1-9d23058b8549", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4d1ab51b-f3d2-42ca-860d-bbcd52c6ce71", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1819c975-6cce-4081-88d1-9d23058b8549", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4d1ab51b-f3d2-42ca-860d-bbcd52c6ce71", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "423abd30-1790-4ccb-bc0c-1952e377bd82", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "e7bd593b-c3aa-4216-bda7-a7deac02b573", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1819c975-6cce-4081-88d1-9d23058b8549", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4d1ab51b-f3d2-42ca-860d-bbcd52c6ce71", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1819c975-6cce-4081-88d1-9d23058b8549", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4d1ab51b-f3d2-42ca-860d-bbcd52c6ce71", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "423abd30-1790-4ccb-bc0c-1952e377bd82", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-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": "352d4bbd-7bf7-4bab-be00-a0bf4c09daa0", "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": "ab86ffd5-6fc2-4b6e-817c-17d94667e4ee", "Teams": [ { "TeamId": "417f3840-fbde-4504-a585-bb4df7afe7a2", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "0cc2fb25-241a-4f0a-99a6-8f7e4f82e23a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "77e45cae-1f83-4608-8d50-f273e9eccc70", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "0cc2fb25-241a-4f0a-99a6-8f7e4f82e23a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "77e45cae-1f83-4608-8d50-f273e9eccc70", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4169bd9c-4357-4c7d-a67c-bfb7d24cdf12", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "417f3840-fbde-4504-a585-bb4df7afe7a2", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "0cc2fb25-241a-4f0a-99a6-8f7e4f82e23a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "77e45cae-1f83-4608-8d50-f273e9eccc70", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "0cc2fb25-241a-4f0a-99a6-8f7e4f82e23a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "MeasurementValueNeededDate": "2025-06-27T06:53:03.9134623-07:00", "SourceSystemId": "sample string 3", "CompanyId": "77e45cae-1f83-4608-8d50-f273e9eccc70", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4169bd9c-4357-4c7d-a67c-bfb7d24cdf12", "CreateDate": "2025-06-27T06:53:03.9134623-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:53:03.9134623-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }