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": "2f200a42-97d9-4a8e-b93e-c453f0deed17", "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": "7c34f5e6-0abf-423d-97e5-e6c58f938b73", "Teams": [ { "TeamId": "d1bc4e17-9de0-4a0e-adf9-5b26483dcd9b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "7d11ebfb-b56c-4c3f-8b93-ca4a075ff547", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "478e19d3-ef43-4715-b0e2-369b9c60d037", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "7d11ebfb-b56c-4c3f-8b93-ca4a075ff547", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "478e19d3-ef43-4715-b0e2-369b9c60d037", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "abdf19b1-b850-462b-9555-a30d5c4089ce", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d1bc4e17-9de0-4a0e-adf9-5b26483dcd9b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "7d11ebfb-b56c-4c3f-8b93-ca4a075ff547", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "478e19d3-ef43-4715-b0e2-369b9c60d037", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "7d11ebfb-b56c-4c3f-8b93-ca4a075ff547", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "478e19d3-ef43-4715-b0e2-369b9c60d037", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "abdf19b1-b850-462b-9555-a30d5c4089ce", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-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": "bd04ec46-e39a-47e9-bcfd-1d169a18ffd0", "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": "642d39c4-7ac2-47c0-8253-3696e1a8944d", "Teams": [ { "TeamId": "9cb01848-b0f0-4eac-9e7a-73d1e1efeb85", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "af62746a-ef78-4ee2-b606-6244a6304692", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a38e9bfc-7d52-4622-847e-ffdfbc699a20", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "af62746a-ef78-4ee2-b606-6244a6304692", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a38e9bfc-7d52-4622-847e-ffdfbc699a20", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e0e15a14-8e4d-43a2-9a13-b7e7994a0cb3", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9cb01848-b0f0-4eac-9e7a-73d1e1efeb85", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "af62746a-ef78-4ee2-b606-6244a6304692", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a38e9bfc-7d52-4622-847e-ffdfbc699a20", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "af62746a-ef78-4ee2-b606-6244a6304692", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "MeasurementValueNeededDate": "2025-05-09T01:29:58.829902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a38e9bfc-7d52-4622-847e-ffdfbc699a20", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e0e15a14-8e4d-43a2-9a13-b7e7994a0cb3", "CreateDate": "2025-05-09T01:29:58.829902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:29:58.829902-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }