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": "8d58e849-d8d5-47a0-8c68-3abfa8f39647", "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": "cd09d103-a947-4216-84ed-db0019509467", "Teams": [ { "TeamId": "fd0e83cb-b4c4-4fe6-82ca-fd72a9085e59", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "98e64741-41c5-4f9a-9958-655bee0b9bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "569ba4af-fd56-4923-8beb-0aa870795509", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "98e64741-41c5-4f9a-9958-655bee0b9bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "569ba4af-fd56-4923-8beb-0aa870795509", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "96895220-ffb1-4691-ac7b-96644ade03e5", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "fd0e83cb-b4c4-4fe6-82ca-fd72a9085e59", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "98e64741-41c5-4f9a-9958-655bee0b9bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "569ba4af-fd56-4923-8beb-0aa870795509", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "98e64741-41c5-4f9a-9958-655bee0b9bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "569ba4af-fd56-4923-8beb-0aa870795509", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "96895220-ffb1-4691-ac7b-96644ade03e5", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-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": "c418753e-1bce-4bab-895d-6c1469e45069", "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": "a2f0044f-cdfe-4632-a3e7-fba1dfc44daf", "Teams": [ { "TeamId": "08c22f7b-80b8-4b49-9bd5-4c77006dc6d0", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8eefe519-6790-49a4-b57f-9f1144550f33", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1f805e49-07c5-4caf-adf4-549dc6d2dc4b", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8eefe519-6790-49a4-b57f-9f1144550f33", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1f805e49-07c5-4caf-adf4-549dc6d2dc4b", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "18105f3a-d223-4a83-bd49-433e8a82fdb3", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "08c22f7b-80b8-4b49-9bd5-4c77006dc6d0", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8eefe519-6790-49a4-b57f-9f1144550f33", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1f805e49-07c5-4caf-adf4-549dc6d2dc4b", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8eefe519-6790-49a4-b57f-9f1144550f33", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "MeasurementValueNeededDate": "2025-03-09T08:33:59.5986785-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1f805e49-07c5-4caf-adf4-549dc6d2dc4b", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "18105f3a-d223-4a83-bd49-433e8a82fdb3", "CreateDate": "2025-03-09T08:33:59.5986785-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:33:59.5986785-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }