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": "af0a626d-4a44-438f-90a9-b1249c5cac16", "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": "abe7ce4c-54fe-4d2c-b73b-7961548e507a", "Teams": [ { "TeamId": "8198e5e4-2340-4681-bf5d-ec857e12ac83", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "769a62c4-3991-4ef9-8799-55bd50df0b56", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7ba4faa1-a4af-444a-bc2c-78122a3fb47d", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "769a62c4-3991-4ef9-8799-55bd50df0b56", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7ba4faa1-a4af-444a-bc2c-78122a3fb47d", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3f7edc48-7527-48ca-ad9b-b70c6d7b39ad", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8198e5e4-2340-4681-bf5d-ec857e12ac83", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "769a62c4-3991-4ef9-8799-55bd50df0b56", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7ba4faa1-a4af-444a-bc2c-78122a3fb47d", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "769a62c4-3991-4ef9-8799-55bd50df0b56", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7ba4faa1-a4af-444a-bc2c-78122a3fb47d", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3f7edc48-7527-48ca-ad9b-b70c6d7b39ad", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08: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": "4e3102d1-3614-49ee-9907-bc0a2c328eb0", "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": "9c8ef543-b1e5-4867-b6c5-0276196d4e60", "Teams": [ { "TeamId": "7cbf9384-92fc-4678-a753-ad80d308998b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b3871d43-e554-4c22-a4a4-c342b4c91112", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "cbd2db2f-eb95-4d54-9ec0-acd9b30b6033", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b3871d43-e554-4c22-a4a4-c342b4c91112", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "cbd2db2f-eb95-4d54-9ec0-acd9b30b6033", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "fd30c005-3199-4ae2-9808-503cc4150fa7", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "7cbf9384-92fc-4678-a753-ad80d308998b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b3871d43-e554-4c22-a4a4-c342b4c91112", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "cbd2db2f-eb95-4d54-9ec0-acd9b30b6033", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b3871d43-e554-4c22-a4a4-c342b4c91112", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "MeasurementValueNeededDate": "2025-01-02T10:40:03.6244995-08:00", "SourceSystemId": "sample string 3", "CompanyId": "cbd2db2f-eb95-4d54-9ec0-acd9b30b6033", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "fd30c005-3199-4ae2-9808-503cc4150fa7", "CreateDate": "2025-01-02T10:40:03.6244995-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T10:40:03.6244995-08:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }