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": "fda3d3ce-84ee-4228-b1f2-2f87644646ba", "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": "5a7b03d7-defe-444b-b331-af879b2dc868", "Teams": [ { "TeamId": "6e4300f6-319a-43e9-b3c6-487862d5709b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "2a1da0f5-1dcd-438c-b211-838a3a7aebe2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4761b3c2-30b7-4de0-bc22-b294bebc9a6d", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "2a1da0f5-1dcd-438c-b211-838a3a7aebe2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4761b3c2-30b7-4de0-bc22-b294bebc9a6d", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "f2e0f177-c624-4a8a-92a0-313560a0ffde", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "6e4300f6-319a-43e9-b3c6-487862d5709b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "2a1da0f5-1dcd-438c-b211-838a3a7aebe2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4761b3c2-30b7-4de0-bc22-b294bebc9a6d", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "2a1da0f5-1dcd-438c-b211-838a3a7aebe2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4761b3c2-30b7-4de0-bc22-b294bebc9a6d", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "f2e0f177-c624-4a8a-92a0-313560a0ffde", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-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": "aa822d4a-7e60-4ee0-8475-e7e00e07c359", "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": "c3db6a9e-26df-43bb-82da-8dd2b62ad05e", "Teams": [ { "TeamId": "d5254592-3f76-447a-9e5f-3c8361dce787", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "99d34b1a-4b7c-4f80-a2bb-5d2ca0feb28d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4832b28e-eb9d-4abe-983c-e3fdbd30dd92", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "99d34b1a-4b7c-4f80-a2bb-5d2ca0feb28d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4832b28e-eb9d-4abe-983c-e3fdbd30dd92", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "76ed22eb-3080-41ad-865f-e6902f4a4150", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d5254592-3f76-447a-9e5f-3c8361dce787", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "99d34b1a-4b7c-4f80-a2bb-5d2ca0feb28d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4832b28e-eb9d-4abe-983c-e3fdbd30dd92", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "99d34b1a-4b7c-4f80-a2bb-5d2ca0feb28d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "MeasurementValueNeededDate": "2025-04-24T13:55:54.5363394-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4832b28e-eb9d-4abe-983c-e3fdbd30dd92", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "76ed22eb-3080-41ad-865f-e6902f4a4150", "CreateDate": "2025-04-24T13:55:54.5363394-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:55:54.5363394-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }