PUT Users
Updates the given user.
Request Information
URI Parameters
None.
Body Parameters
User to be updated
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": "52b7aece-72fa-42d7-b07f-943a6a3cfbc5", "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": "8db25dce-5120-47cd-9653-cc6ef1174ffc", "Teams": [ { "TeamId": "ea7297b1-0c94-4f8d-8616-aa1e9388fc4a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "72bfd015-8651-4386-81c7-8cffc8b75b5f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9917912f-0790-4d16-a3ce-42123f7265f6", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "72bfd015-8651-4386-81c7-8cffc8b75b5f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9917912f-0790-4d16-a3ce-42123f7265f6", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "272e13b2-11b3-425b-b46d-90eb89fe79ec", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "ea7297b1-0c94-4f8d-8616-aa1e9388fc4a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "72bfd015-8651-4386-81c7-8cffc8b75b5f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9917912f-0790-4d16-a3ce-42123f7265f6", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "72bfd015-8651-4386-81c7-8cffc8b75b5f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9917912f-0790-4d16-a3ce-42123f7265f6", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "272e13b2-11b3-425b-b46d-90eb89fe79ec", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" } ] }
Response Information
Resource Description
On success, the updated user.
Name | Description | Type | Additional information |
---|---|---|---|
Data | User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "UserId": "b880fe04-b56b-477d-bd88-4c679a474b8a", "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": "b926db00-856b-4f7c-b1e8-00b299455447", "Teams": [ { "TeamId": "7ffdc2d6-8788-43af-a418-70a267230024", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "159f3e1d-b859-443b-a073-a03cb787cd16", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f22dd304-5b73-4a10-a83a-dd7efc80712a", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "159f3e1d-b859-443b-a073-a03cb787cd16", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f22dd304-5b73-4a10-a83a-dd7efc80712a", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ce4ac110-d255-4f3a-a8c9-07206b8e5116", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "7ffdc2d6-8788-43af-a418-70a267230024", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "159f3e1d-b859-443b-a073-a03cb787cd16", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f22dd304-5b73-4a10-a83a-dd7efc80712a", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "159f3e1d-b859-443b-a073-a03cb787cd16", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "MeasurementValueNeededDate": "2025-09-13T18:31:18.6436042-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f22dd304-5b73-4a10-a83a-dd7efc80712a", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ce4ac110-d255-4f3a-a8c9-07206b8e5116", "CreateDate": "2025-09-13T18:31:18.6436042-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:31:18.6436042-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }