Horizon Cloud Connector 2.4 and Later - Update the Registered Active Directory Credentials Used By Horizon Cloud Connector with Horizon Connection Server

This documentation page describes the API to use when you are rotating the Horizon Connection Server administrator's password in your Active Directory system. In this use case, you use this API to have Horizon Cloud Connector use the new value.

This feature is supported for use with Horizon Cloud Connector version 2.4 and later.

The Horizon Cloud Connector uses the administrator credentials that were entered during the onboarding and pairing process to communicate with the Horizon Connection Server.

Over time, those administrator credentials might get changed in your Active Directory domain, or they become expired or become invalid. If Horizon Cloud Connector appliance is not informed about the new credentials when the administrator credentials are updated in the Active Directory domain, the Horizon Cloud Connector loses connectivity with the Horizon Connection Server.

When you need to update the administrator's password, you can use this API to update the administrator password stored in the appliance to match the value configured in the Active Directory domain account.

• API endpoint

  The appliance endpoint for updating the stored password is https://appliance-address/viewproxyadapter/local/config/rotate

  Where appliance-address is one of the following:

  • https://IP-address/viewproxyadapter/local/config/rotate, where IP-address is the appliance's IP address.
  • https://FQDN/viewproxyadapter/local/config/rotate, if you mapped the appliance's IP address to an FQDN in your DNS server.

• API method PUT

• Request payload

  The payload requires the Active Directory DNS domain name, the account name, the password stored in the appliance (the previous password), and the new password.

  For the passwords, wrap each letter in quote marks and separate the wrapped letters with commas. In the following sample, the password stored in the appliance is abcd!efg and tuvw$xyz is the new password.

  
  {
     "domain":"AD-dns-domain-name",
     "userName":"admin-account-name",
     "oldPassword":["a","b","c","d","!","e","f","g"],
     "newPassword":["t","u","v","w","$","x","y","z"]
  }
  

• When the API is invoked

  The Horizon Cloud Connector compares the existing credentials you provide in the API payload with what is stored in the Horizon Cloud Connector appliance.

  If the validation succeeds, the system attempts a login attempt to the Horizon Connection Server using the new credentials provided in the API payload.

  If that login attempt succeeds, the services within the appliance reload to pick up the new credentials and start using them.

  Note: This API is rate limited at one request per minute. If the attempts exceed the rate limit, then HTTP error 429 (Too many requests) is returned.

• API authorization

  The authorization check is done by comparing the domain, userName, andoldPassword provided in the request payload with the credentials that are known to Horizon Cloud Connector. The known credentials are either those that were provided during the onboarding and pairing process or during a prior credential rotation using this API.

Prerequisites

Before issuing the API command, verify the following items.

• The Horizon Cloud Connector is paired with the Horizon pod, with the pod's Horizon Connection Server.
• You have the Active Directory domain's DNS name and the Horizon Connection Server administrator credentials.
• In your Active Directory domain, you have updated the Horizon Connection Server administrator account's password to the new password that you want used.
• You have the previously used password, the existing one that is known to the Horizon Cloud Connector appliance, which the appliance is currently using.

Procedure

1. Issue a PUT to the API endpoint https://appliance-address/viewproxyadapter/local/config/rotate with the request payload.

   In the following example, the AD domain is example.com, the account is named CSadmin, the previous password is abcd!efg, and the new password is tuvw$xyz.

   
   {
      "domain":"example.com",
      "userName":"CSadmin",
      "oldPassword":["a","b","c","d","!","e","f","g"],
      "newPassword":["t","u","v","w","$","x","y","z"]
   }
   

   When the passwords are rotated successfully, the returned response is 200 success.

What to do next

To verify that the Horizon Cloud Connector is connecting to the Horizon Connection Server using the updated password, you can log in to the Horizon Cloud Connector configuration portal, click the refresh arrow, and verify that the Connection Server status displays green.