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": "d3011df5-bfca-40f7-9e22-18a6995b91fb", "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": "84ac4763-dabf-4b11-a726-8da7774287d8", "Teams": [ { "TeamId": "87c4289b-6be9-4e40-83c3-af48fb766a16", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "89484e07-7224-4697-8c8a-c2098b8dd0d9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36204bcd-ebe4-409d-83f0-2316c85f7958", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "89484e07-7224-4697-8c8a-c2098b8dd0d9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36204bcd-ebe4-409d-83f0-2316c85f7958", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3aa01b8d-5392-4ab0-b01b-ed537da4eb49", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "87c4289b-6be9-4e40-83c3-af48fb766a16", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "89484e07-7224-4697-8c8a-c2098b8dd0d9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36204bcd-ebe4-409d-83f0-2316c85f7958", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "89484e07-7224-4697-8c8a-c2098b8dd0d9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36204bcd-ebe4-409d-83f0-2316c85f7958", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3aa01b8d-5392-4ab0-b01b-ed537da4eb49", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-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": "da506c3c-d768-4288-a42d-e728b19ca112", "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": "1a7fb8d3-b767-47b6-b51a-47c1ff35daa5", "Teams": [ { "TeamId": "0330482e-4b15-40bc-a5a9-aa7e81fdd54b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "c0f4d0c0-8c02-45e2-a868-853237624423", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d3488aa9-23f5-4b76-a640-9c1f8daef433", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "c0f4d0c0-8c02-45e2-a868-853237624423", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d3488aa9-23f5-4b76-a640-9c1f8daef433", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "428fe513-8d24-467a-b4ed-f8ec6b3e1035", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "0330482e-4b15-40bc-a5a9-aa7e81fdd54b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "c0f4d0c0-8c02-45e2-a868-853237624423", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d3488aa9-23f5-4b76-a640-9c1f8daef433", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "c0f4d0c0-8c02-45e2-a868-853237624423", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "MeasurementValueNeededDate": "2025-06-23T00:01:58.0971285-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d3488aa9-23f5-4b76-a640-9c1f8daef433", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "428fe513-8d24-467a-b4ed-f8ec6b3e1035", "CreateDate": "2025-06-23T00:01:58.0971285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-23T00:01:58.0971285-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }