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": "f122f104-ccc4-40f8-a50a-47930edd8c17", "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": "9001e657-6b29-4aeb-81d1-c8356ce3ed23", "Teams": [ { "TeamId": "8b422c05-ee69-4c9d-9ffd-8611a5e49b81", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ff786916-25ad-4395-aa61-81f9286ad7c3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "accdce63-3d91-4623-81b8-e2e54861cb28", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ff786916-25ad-4395-aa61-81f9286ad7c3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "accdce63-3d91-4623-81b8-e2e54861cb28", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "a992dbc6-71ae-4d1c-902e-ac4c3de82bb5", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8b422c05-ee69-4c9d-9ffd-8611a5e49b81", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ff786916-25ad-4395-aa61-81f9286ad7c3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "accdce63-3d91-4623-81b8-e2e54861cb28", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ff786916-25ad-4395-aa61-81f9286ad7c3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "accdce63-3d91-4623-81b8-e2e54861cb28", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "a992dbc6-71ae-4d1c-902e-ac4c3de82bb5", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-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": "247deea5-c293-43f5-96b5-d9d534289c95", "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": "a24692bd-3f1f-40bc-83db-283640cb2075", "Teams": [ { "TeamId": "5f7a52a4-191e-4cf1-830b-d206133e685d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a4259851-157e-43d1-896b-3786934c4177", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4999505e-6cd3-4c60-93b9-920260a28d98", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a4259851-157e-43d1-896b-3786934c4177", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4999505e-6cd3-4c60-93b9-920260a28d98", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "82afd89e-c35a-4ef7-a2a7-b3e490eea2f5", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "5f7a52a4-191e-4cf1-830b-d206133e685d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a4259851-157e-43d1-896b-3786934c4177", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4999505e-6cd3-4c60-93b9-920260a28d98", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a4259851-157e-43d1-896b-3786934c4177", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "MeasurementValueNeededDate": "2025-04-30T14:13:48.0439428-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4999505e-6cd3-4c60-93b9-920260a28d98", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "82afd89e-c35a-4ef7-a2a7-b3e490eea2f5", "CreateDate": "2025-04-30T14:13:48.0439428-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:13:48.0439428-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }