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": "751ab9ac-dfd2-408c-99ce-b2d75d52b5bb", "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": "1f665403-b3c0-4f9c-bcf2-2f84f12a10d9", "Teams": [ { "TeamId": "ba953a80-a9b3-4450-80c9-b132c15692c9", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4e06e35f-a8a5-4a72-a841-af9d23749412", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2a788b8d-3aeb-4c2f-adcf-78f0193d341f", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4e06e35f-a8a5-4a72-a841-af9d23749412", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2a788b8d-3aeb-4c2f-adcf-78f0193d341f", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "13b45b13-c646-4355-8b9d-727f00bf91fa", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "ba953a80-a9b3-4450-80c9-b132c15692c9", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4e06e35f-a8a5-4a72-a841-af9d23749412", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2a788b8d-3aeb-4c2f-adcf-78f0193d341f", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4e06e35f-a8a5-4a72-a841-af9d23749412", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2a788b8d-3aeb-4c2f-adcf-78f0193d341f", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "13b45b13-c646-4355-8b9d-727f00bf91fa", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-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": "d3272b35-bbf7-4793-bc01-0d7c6e0aa791", "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": "1db5b899-5263-4c38-ba72-69aa943df9a5", "Teams": [ { "TeamId": "a96a601f-58c9-46d1-a153-9f3487b7a34c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a2095847-d972-43ec-9c55-46fc0c802b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9b103ee5-1943-4bd4-9cef-1de7923841f0", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a2095847-d972-43ec-9c55-46fc0c802b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9b103ee5-1943-4bd4-9cef-1de7923841f0", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7b1d3113-f6a9-4266-ab85-aa358e8ba928", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "a96a601f-58c9-46d1-a153-9f3487b7a34c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a2095847-d972-43ec-9c55-46fc0c802b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9b103ee5-1943-4bd4-9cef-1de7923841f0", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a2095847-d972-43ec-9c55-46fc0c802b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "MeasurementValueNeededDate": "2025-04-03T15:19:08.0290207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9b103ee5-1943-4bd4-9cef-1de7923841f0", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7b1d3113-f6a9-4266-ab85-aa358e8ba928", "CreateDate": "2025-04-03T15:19:08.0290207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:19:08.0290207-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }