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": "c575bfea-cadd-47fb-ac0e-ca2b2a6b4c3c", "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": "b5bd7d09-c2df-4584-9626-b24f685b462e", "Teams": [ { "TeamId": "eb578f80-6de6-4d7e-9ac6-daa4f8d2df68", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "74dbcea7-0673-4943-853e-2ba6644ab375", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "97e06688-a469-4045-b930-542b8e808a6c", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "74dbcea7-0673-4943-853e-2ba6644ab375", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "97e06688-a469-4045-b930-542b8e808a6c", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "856a31a3-35f9-40f8-89ec-7caa92778166", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "eb578f80-6de6-4d7e-9ac6-daa4f8d2df68", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "74dbcea7-0673-4943-853e-2ba6644ab375", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "97e06688-a469-4045-b930-542b8e808a6c", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "74dbcea7-0673-4943-853e-2ba6644ab375", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "97e06688-a469-4045-b930-542b8e808a6c", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "856a31a3-35f9-40f8-89ec-7caa92778166", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-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": "c666e220-7b99-4c63-ac7c-a1b56c672886", "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": "a6adf0e5-c43e-4f4d-9b21-d2785931cf51", "Teams": [ { "TeamId": "7eb6ab99-c268-497c-baa6-c6922ba929ca", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9e3831dc-7662-40b2-bd28-a988900c97ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dc449c6e-b87f-4a51-8054-c38c907b35b4", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9e3831dc-7662-40b2-bd28-a988900c97ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dc449c6e-b87f-4a51-8054-c38c907b35b4", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4c3b610b-2a5e-40a9-8fd6-9b4ba38550b1", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "7eb6ab99-c268-497c-baa6-c6922ba929ca", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9e3831dc-7662-40b2-bd28-a988900c97ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dc449c6e-b87f-4a51-8054-c38c907b35b4", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9e3831dc-7662-40b2-bd28-a988900c97ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "MeasurementValueNeededDate": "2025-05-09T15:39:27.9352707-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dc449c6e-b87f-4a51-8054-c38c907b35b4", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4c3b610b-2a5e-40a9-8fd6-9b4ba38550b1", "CreateDate": "2025-05-09T15:39:27.9352707-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:39:27.9352707-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }