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": "a051f08d-98e8-431e-824b-cbe4a168cadb", "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": "6974c183-3eaf-4c98-8c71-fca29b48e882", "Teams": [ { "TeamId": "bbd2d21f-ece4-40ca-ac93-43c97dd08cb1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b68aa167-c3b3-43d5-9c7a-7a03cd51326b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a0040019-49bb-46df-85a7-c63efa4c7bfa", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b68aa167-c3b3-43d5-9c7a-7a03cd51326b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a0040019-49bb-46df-85a7-c63efa4c7bfa", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "9920b6f5-b62b-44b7-b6a1-57fb06423aa9", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "bbd2d21f-ece4-40ca-ac93-43c97dd08cb1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b68aa167-c3b3-43d5-9c7a-7a03cd51326b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a0040019-49bb-46df-85a7-c63efa4c7bfa", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b68aa167-c3b3-43d5-9c7a-7a03cd51326b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a0040019-49bb-46df-85a7-c63efa4c7bfa", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "9920b6f5-b62b-44b7-b6a1-57fb06423aa9", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-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": "04470ba0-3332-4c49-a570-7168e02dc9db", "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": "1cb6fdd0-f4fe-40cb-bc45-12bab2508daa", "Teams": [ { "TeamId": "e44afcb4-e220-48dd-95ad-5121c55cca6f", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4b4dfbce-85aa-4d09-8af1-9bee94d39af4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6fbe1872-d210-4449-9408-633fa130e20a", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4b4dfbce-85aa-4d09-8af1-9bee94d39af4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6fbe1872-d210-4449-9408-633fa130e20a", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3a5e7486-9043-4395-bd09-ca280ab66729", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "e44afcb4-e220-48dd-95ad-5121c55cca6f", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4b4dfbce-85aa-4d09-8af1-9bee94d39af4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6fbe1872-d210-4449-9408-633fa130e20a", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4b4dfbce-85aa-4d09-8af1-9bee94d39af4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "MeasurementValueNeededDate": "2025-08-29T17:15:14.3596524-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6fbe1872-d210-4449-9408-633fa130e20a", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3a5e7486-9043-4395-bd09-ca280ab66729", "CreateDate": "2025-08-29T17:15:14.3596524-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:15:14.3596524-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }