PATCH /service/api/securecloud/customers/{customerId}/users/{userId}

Updates a user for an end customer.

Note: This method supports regular JSON patches (partial object updates) only and does not cover JSON Patch (RFC 6902).

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
customerId

A unique id by which an end customer is identified.

string

Required

userId

A unique id by which the user is identified.

string

Required

URI Sample(s)

PATCH
https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf/users/2e0a7a3c-92b7-480d-a48f-a18600f660af

Body Parameters

Information about the user to be updated for the customer.

UpdateCustomerUserRequestModel
NameDescriptionTypeAdditional Information
FirstName

First name of the user. The first name can have a maximum of 50 characters.

string

Max length: 50

LastName

Last name of the user. The last name can have a maximum of 50 characters.

string

Max length: 50

PhoneNumber

Phone number of the user. The phone number can have a maximum of 50 characters.

string

Max length: 50

Roles

Roles assignable to the user. User roles are listed in order of privilege, from highest to lowest.
Valid Roles for a Partner Customer:

  • Partner_Administrator
  • Partner_Sales
  • Partner_Support
  • Customer_Administrator
  • Billing
Valid Role for a Resold Customer:
  • Customer_Administrator
Default Access:
If no role is specified, the user is granted access only to their own services, without any administrative privileges.

Collection of string

None.

Sample Request

{
  "FirstName": "Richard",
  "LastName": "Illingworth",
  "PhoneNumber": "1234567890",
  "Roles": [
    "Partner_Administrator",
    "Billing"
  ]
}                    
<UpdateCustomerUserRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <FirstName>Richard</FirstName>
  <LastName>Illingworth</LastName>
  <PhoneNumber>1234567890</PhoneNumber>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Partner_Administrator</d2p1:string>
    <d2p1:string>Billing</d2p1:string>
  </Roles>
</UpdateCustomerUserRequestModel>                    

Response Information

Resource Description

Additional information received while updating the user.

UpdateCustomerUserResponseModel
NameDescriptionTypeAdditional Information
Message

Additional information received while updating the user.

string

None.

Sample Response

{
  "Message": "User was updated"
}                    
<UpdateCustomerUserResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <Message>User was updated</Message>
</UpdateCustomerUserResponseModel>