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": "b45b090f-e445-43cb-b7a7-5c66e390f529", "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": "128e6458-c12b-4bc6-9e03-bdea040261c9", "Teams": [ { "TeamId": "52a51c7e-83f1-49f9-aa1c-2403cc7880e6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "686b23eb-7573-45a7-b94c-678a20caa7d3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "51873946-628f-45a2-907c-4bd0a3bb6192", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "686b23eb-7573-45a7-b94c-678a20caa7d3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "51873946-628f-45a2-907c-4bd0a3bb6192", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "f987ee97-3b8e-4d58-a721-aa14125ba792", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "52a51c7e-83f1-49f9-aa1c-2403cc7880e6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "686b23eb-7573-45a7-b94c-678a20caa7d3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "51873946-628f-45a2-907c-4bd0a3bb6192", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "686b23eb-7573-45a7-b94c-678a20caa7d3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "51873946-628f-45a2-907c-4bd0a3bb6192", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "f987ee97-3b8e-4d58-a721-aa14125ba792", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-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": "40a9917e-7166-44d3-8304-e85bb8ddf6b8", "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": "32614f3e-b605-45c3-bd2d-43b66f98037f", "Teams": [ { "TeamId": "c60816b6-d7f0-455b-9805-6cf151ec8eb8", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "2d7a9c32-4fec-45b1-a6e2-1877f4633586", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4bd34c9c-51e4-480e-9fff-43fb8a8aecbe", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "2d7a9c32-4fec-45b1-a6e2-1877f4633586", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4bd34c9c-51e4-480e-9fff-43fb8a8aecbe", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ca5aad9a-e457-4383-8ee8-9e39b55a6192", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "c60816b6-d7f0-455b-9805-6cf151ec8eb8", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "2d7a9c32-4fec-45b1-a6e2-1877f4633586", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4bd34c9c-51e4-480e-9fff-43fb8a8aecbe", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "2d7a9c32-4fec-45b1-a6e2-1877f4633586", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "MeasurementValueNeededDate": "2025-06-25T06:18:16.8563512-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4bd34c9c-51e4-480e-9fff-43fb8a8aecbe", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ca5aad9a-e457-4383-8ee8-9e39b55a6192", "CreateDate": "2025-06-25T06:18:16.8563512-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:18:16.8563512-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }