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

Updates service and service configuration for an end customer's user.

Note: To update user services for a user, callers typically begin by fetching the current service and domain assignments using the Get User Details API. This response provides the set of services and domains currently assigned to the user. Once retrieved, the caller can modify the configuration as needed by adding, removing, or updating services and then pass the updated data to the Update User Services API.

Request Information

URI Parameters

Name	Description	Type	Additional 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/services

Body Parameters

Service and service configuration about the user to be updated.

UpdateUserServicesRequestModel

Name	Description	Type	Additional Information
UserServices	Services information for the user.	Collection of UpdateUserServiceRequestModelService	None.

Sample Request

{
  "UserServices": [
    {
      "ServiceName": "Office365",
      "RemoveService": false,
      "ServiceConfiguration": [
        {
          "Name": "UsageLocation",
          "Value": [
            "UnitedSates"
          ]
        },
        {
          "Name": "SelectedLicenses",
          "Value": [
            "80b2d799-d2ba-4d2a-8842-fb0d0f3a4b82",
            "3b555118-da6a-4418-894f-7df1e2096870"
          ]
        },
        {
          "Name": "IsOffice365Admin",
          "Value": [
            "false"
          ]
        }
      ]
    },
    {
      "ServiceName": "Backup Administrator",
      "RemoveService": true,
      "ServiceConfiguration": null
    }
  ]
}

<UpdateUserServicesRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <UserServices>
    <UpdateUserServicesRequestModel.UpdateUserServiceRequestModelService>
      <ServiceName>Office365</ServiceName>
      <ServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>UsageLocation</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>UnitedSates</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>SelectedLicenses</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>80b2d799-d2ba-4d2a-8842-fb0d0f3a4b82</d6p1:string>
            <d6p1:string>3b555118-da6a-4418-894f-7df1e2096870</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>IsOffice365Admin</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>false</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
      </ServiceConfiguration>
      <RemoveService>false</RemoveService>
    </UpdateUserServicesRequestModel.UpdateUserServiceRequestModelService>
    <UpdateUserServicesRequestModel.UpdateUserServiceRequestModelService>
      <ServiceName>Backup Administrator</ServiceName>
      <ServiceConfiguration i:nil="true" />
      <RemoveService>true</RemoveService>
    </UpdateUserServicesRequestModel.UpdateUserServiceRequestModelService>
  </UserServices>
</UpdateUserServicesRequestModel>

Response Information

Resource Description

Additional information received while updating user services for the user.

UpdateUserServicesResponseModel

Name	Description	Type	Additional Information
Message	Additional information received while updating user services for the user.	string	None.
UserConfigurations	Services information for a user.	Collection of UserService	This field is returned only when the service configuration has been updated with differences from the request defined.

Sample Response

{
  "Message": "User was updated",
  "UserConfigurations": [
    {
      "ServiceName": "Office365",
      "ServiceConfiguration": [
        {
          "Name": "IsOffice365Admin",
          "Value": [
            "true"
          ]
        }
      ]
    }
  ]
}

<UpdateUserServicesResponseModel 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>
  <UserConfigurations>
    <UserService>
      <ServiceName>Office365</ServiceName>
      <ServiceConfiguration>
        <UserServiceServiceConfiguration>
          <Name>IsOffice365Admin</Name>
          <Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>true</d6p1:string>
          </Value>
        </UserServiceServiceConfiguration>
      </ServiceConfiguration>
    </UserService>
  </UserConfigurations>
</UpdateUserServicesResponseModel>