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": "425d8b60-c4c1-4572-9154-120062329f8d", "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": "f4addf0f-cac5-4549-8c1f-b9882af1e16e", "Teams": [ { "TeamId": "a907ca79-852d-4617-835f-de5cd1887218", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "473889dc-8a6d-4a1a-bf7f-7222f3fac1ef", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6b5d4000-bb06-4646-9596-58a0e243c4c8", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "473889dc-8a6d-4a1a-bf7f-7222f3fac1ef", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6b5d4000-bb06-4646-9596-58a0e243c4c8", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "86058c84-f7d7-4d40-aa4a-34404171e005", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "a907ca79-852d-4617-835f-de5cd1887218", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "473889dc-8a6d-4a1a-bf7f-7222f3fac1ef", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6b5d4000-bb06-4646-9596-58a0e243c4c8", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "473889dc-8a6d-4a1a-bf7f-7222f3fac1ef", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6b5d4000-bb06-4646-9596-58a0e243c4c8", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "86058c84-f7d7-4d40-aa4a-34404171e005", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-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": "e6feb37c-224e-4695-9b15-0c08b5340682", "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": "90e2ba7a-091d-406e-8a2f-83903867f5ca", "Teams": [ { "TeamId": "6d343968-86da-467e-93bc-399d4c3ef268", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "0c4bd262-199e-4b60-9b65-5e386b1f8179", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0431a8cb-e3b5-44f2-b06a-b26ea6eb2955", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "0c4bd262-199e-4b60-9b65-5e386b1f8179", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0431a8cb-e3b5-44f2-b06a-b26ea6eb2955", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c84172ec-1461-4451-80d6-0eacb9c4b3b4", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "6d343968-86da-467e-93bc-399d4c3ef268", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "0c4bd262-199e-4b60-9b65-5e386b1f8179", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0431a8cb-e3b5-44f2-b06a-b26ea6eb2955", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "0c4bd262-199e-4b60-9b65-5e386b1f8179", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "MeasurementValueNeededDate": "2025-06-26T11:30:38.8525188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0431a8cb-e3b5-44f2-b06a-b26ea6eb2955", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c84172ec-1461-4451-80d6-0eacb9c4b3b4", "CreateDate": "2025-06-26T11:30:38.8525188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T11:30:38.8525188-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }