此說明文件頁面說明當您在輪替 Active Directory 系統中的 Horizon Connection Server 管理員密碼時使用的 API。在此使用案例中，您可以使用此 API 讓 Horizon Cloud Connector 使用新值。
此功能可以和 Horizon Cloud Connector 2.4 版及更新版本搭配使用。
Horizon Cloud Connector 使用在上架和配對程序中輸入的管理員認證與 Horizon Connection Server 進行通訊。
隨著時間的推移，這些管理員認證可能會在 Active Directory 網域中變更，或是到期或變得無效。如果在 Active Directory 網域中更新管理員認證時未向 Horizon Cloud Connector 應用裝置通知新認證，Horizon Cloud Connector 與 Horizon Connection Server 之間的連線將中斷。
當您需要更新管理員密碼時，您可以使用此 API 來更新儲存在應用裝置中的管理員密碼，以符合在 Active Directory 網域帳戶中設定的值。
- API 端點
-
用於更新所儲存密碼的應用裝置端點是
https://appliance-address/viewproxyadapter/local/config/rotate
其中，appliance-address 是以下其中之一：
- https://IP-address/viewproxyadapter/local/config/rotate，其中 IP-address 是應用裝置的 IP 位址。
- https://FQDN/viewproxyadapter/local/config/rotate (如果您將應用裝置的 IP 位址對應至 DNS 伺服器中的 FQDN)。
- API 方法
- PUT
- 要求裝載
-
裝載需要 Active Directory DNS 網域名稱、帳戶名稱、儲存在應用裝置中的密碼 (以前的密碼) 和新密碼。
請將密碼的每個字母分別用引號括起來，並使用逗號分隔所括住的字母。在以下範例中，儲存在應用裝置中的密碼是 abcd!efg，而新密碼是 tuvw$xyz。
{ "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"] } - 叫用 API 時
-
Horizon Cloud Connector 會將您在 API 裝載中提供的現有認證，與儲存在
Horizon Cloud Connector 應用裝置中的認證進行比較。
如果驗證成功，系統會嘗試使用 API 裝載中提供的新認證登入 Horizon Connection Server。
如果該登入嘗試成功，應用裝置中的服務將重新載入，以取得並開始使用新認證。
備註： 此 API 的速率限制為每分鐘一個要求。如果嘗試的頻率超過此速率限制，則會傳回 HTTP 錯誤 429 (要求太多)。 - API 授權
- 授權檢查的進行方式是，將要求裝載中提供的 domain、 userName 和 oldPassword，與 Horizon Cloud Connector 已知的認證進行比較。已知認證是在上架和配對程序中提供的認證，或是之前使用此 API 進行認證輪替時提供的認證。
必要條件
在發出 API 命令之前，請驗證以下項目。
- Horizon Cloud Connector 與 Horizon 網繭以及網繭的 Horizon Connection Server 配對。
- 您知道 Active Directory 網域的 DNS 名稱，並有 Horizon Connection Server 管理員認證。
- 在 Active Directory 網域中，您已將 Horizon Connection Server 管理員帳戶的密碼更新為您要使用的新密碼。
- 您有先前使用過的密碼，即 Horizon Cloud Connector 應用裝置已知且正在使用的現有密碼。
程序
- ♦使用要求裝載向 API 端點 https://appliance-address/viewproxyadapter/local/config/rotate 發出 PUT。
在以下範例中，AD 網域為 example.com，帳戶名稱為 CSadmin，先前的密碼為 abcd!efg，新密碼為 tuvw$xyz。
{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }密碼輪替成功後，會傳回 200 success 的回應。
