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": "4a875b46-f299-495b-bb57-c119abf6579d", "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": "3769df00-0655-4d54-8177-7c2a8675e47e", "Teams": [ { "TeamId": "b3ea1720-4f32-4cf9-b458-9935c443cbca", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "29cc0c96-4223-451a-82e2-0862f32b0b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "839ec9db-e462-42d1-9177-20b14c104fda", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "29cc0c96-4223-451a-82e2-0862f32b0b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "839ec9db-e462-42d1-9177-20b14c104fda", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "bedb3a78-62a1-423c-9e31-8351aa7b91bf", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "b3ea1720-4f32-4cf9-b458-9935c443cbca", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "29cc0c96-4223-451a-82e2-0862f32b0b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "839ec9db-e462-42d1-9177-20b14c104fda", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "29cc0c96-4223-451a-82e2-0862f32b0b31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "839ec9db-e462-42d1-9177-20b14c104fda", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "bedb3a78-62a1-423c-9e31-8351aa7b91bf", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-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": "7a8b49ef-2558-4271-a468-44d92515f88e", "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": "13eb272e-d912-463c-a776-3eb4939d728a", "Teams": [ { "TeamId": "ac3d7344-b52a-466f-a804-9e8e05bfac27", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "83d9a263-2f75-41fd-8c30-61da4c1d4250", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "abf2649d-b277-4b26-8cc9-3195f7e50292", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "83d9a263-2f75-41fd-8c30-61da4c1d4250", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "abf2649d-b277-4b26-8cc9-3195f7e50292", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "07645069-7a18-4349-8612-a9b683ef13e4", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "ac3d7344-b52a-466f-a804-9e8e05bfac27", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "83d9a263-2f75-41fd-8c30-61da4c1d4250", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "abf2649d-b277-4b26-8cc9-3195f7e50292", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "83d9a263-2f75-41fd-8c30-61da4c1d4250", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "MeasurementValueNeededDate": "2025-06-30T13:16:49.8143574-07:00", "SourceSystemId": "sample string 3", "CompanyId": "abf2649d-b277-4b26-8cc9-3195f7e50292", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "07645069-7a18-4349-8612-a9b683ef13e4", "CreateDate": "2025-06-30T13:16:49.8143574-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:16:49.8143574-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }