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": "a1b3c717-7a9a-4746-800a-1c92e6a1b590", "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": "f5f82df3-5c6d-4fb6-b0bf-80a7dcf76b4d", "Teams": [ { "TeamId": "52a32983-e709-4092-8fc9-24cd3e03bdd7", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "fc67783b-5096-4a86-840b-ec14fd043cb5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecedfff6-39be-4db2-84c8-98f4a7497587", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "fc67783b-5096-4a86-840b-ec14fd043cb5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecedfff6-39be-4db2-84c8-98f4a7497587", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3a6938ed-a0b6-4770-ac00-c92a112c66e1", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "52a32983-e709-4092-8fc9-24cd3e03bdd7", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "fc67783b-5096-4a86-840b-ec14fd043cb5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecedfff6-39be-4db2-84c8-98f4a7497587", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "fc67783b-5096-4a86-840b-ec14fd043cb5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecedfff6-39be-4db2-84c8-98f4a7497587", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3a6938ed-a0b6-4770-ac00-c92a112c66e1", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-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": "895bbd56-f32c-40ca-96fc-470684fc4dcc", "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": "a9306052-abc0-45d5-9a23-07d4e8b26ebb", "Teams": [ { "TeamId": "a0637084-5c38-4e5b-b272-a74cc2efb8ac", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9fc2087d-809c-4770-89d3-a131c1573f8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a470b0f2-5946-49d6-b26e-5b45acbd6d39", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9fc2087d-809c-4770-89d3-a131c1573f8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a470b0f2-5946-49d6-b26e-5b45acbd6d39", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "55a66f64-bd95-4f0d-b708-35a10a058b59", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "a0637084-5c38-4e5b-b272-a74cc2efb8ac", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9fc2087d-809c-4770-89d3-a131c1573f8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a470b0f2-5946-49d6-b26e-5b45acbd6d39", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9fc2087d-809c-4770-89d3-a131c1573f8d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "MeasurementValueNeededDate": "2025-08-23T22:45:17.186683-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a470b0f2-5946-49d6-b26e-5b45acbd6d39", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "55a66f64-bd95-4f0d-b708-35a10a058b59", "CreateDate": "2025-08-23T22:45:17.186683-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:45:17.186683-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }