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": "93081888-9309-4c36-83b1-9706809a82f7", "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": "042dc9ad-d3d6-4988-826c-76975d36ebd4", "Teams": [ { "TeamId": "9d13cb51-bda3-4ef9-9b59-553be8ecdd87", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1ad4e351-1dfa-4dad-8ac8-c42301b717b2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5a3f9190-ff66-47e7-a939-ab63d4c306c2", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1ad4e351-1dfa-4dad-8ac8-c42301b717b2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5a3f9190-ff66-47e7-a939-ab63d4c306c2", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ff080601-004d-4569-989e-ec42fbfa3b22", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9d13cb51-bda3-4ef9-9b59-553be8ecdd87", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1ad4e351-1dfa-4dad-8ac8-c42301b717b2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5a3f9190-ff66-47e7-a939-ab63d4c306c2", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1ad4e351-1dfa-4dad-8ac8-c42301b717b2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5a3f9190-ff66-47e7-a939-ab63d4c306c2", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ff080601-004d-4569-989e-ec42fbfa3b22", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-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": "1e10b92e-7008-4cc4-b912-81096ab45fe3", "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": "be8070da-7856-4983-bbc0-9ead87c53896", "Teams": [ { "TeamId": "8380db79-77ff-458c-9bdd-d6f360e3ec28", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b18a5a9f-5a97-468a-b6db-fba6c580f02a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "db98a7d8-6338-4540-93b5-1c7069e22470", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b18a5a9f-5a97-468a-b6db-fba6c580f02a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "db98a7d8-6338-4540-93b5-1c7069e22470", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e0976b2d-b791-40d0-8628-f9bf2b23d557", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8380db79-77ff-458c-9bdd-d6f360e3ec28", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b18a5a9f-5a97-468a-b6db-fba6c580f02a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "db98a7d8-6338-4540-93b5-1c7069e22470", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b18a5a9f-5a97-468a-b6db-fba6c580f02a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "MeasurementValueNeededDate": "2025-08-24T10:06:11.9976152-07:00", "SourceSystemId": "sample string 3", "CompanyId": "db98a7d8-6338-4540-93b5-1c7069e22470", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e0976b2d-b791-40d0-8628-f9bf2b23d557", "CreateDate": "2025-08-24T10:06:11.9976152-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:06:11.9976152-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }