Auf dieser Dokumentationsseite wird die API beschrieben, die zu verwenden ist, wenn Sie das Kennwort des Horizon Connection Server-Administrators in Ihrem Active Directory-System aktualisieren möchten. In diesem Anwendungsbeispiel verwenden Sie diese API, damit Horizon Cloud Connector den neuen Wert verwendet.
Diese Funktion wird für Horizon Cloud Connector 2.4 und höher unterstützt.
Horizon Cloud Connector verwendet die Administratoranmeldedaten, die während des Onboarding- und Kopplungsvorgangs eingegeben wurden, um mit dem Horizon Connection Server zu kommunizieren.
Im Laufe der Zeit können sich diese Administratoranmeldedaten in Ihrer Active Directory-Domäne ändern, oder sie sind abgelaufen oder ungültig geworden. Wenn die Horizon Cloud Connector-Appliance nicht über die neuen Anmeldedaten informiert wird, wenn die Administratoranmeldedaten in der Active Directory-Domäne aktualisiert werden, wird die Verbindung vom Horizon Cloud Connector zum Horizon Connection Server unterbrochen.
Wenn Sie das Administratorkennwort aktualisieren müssen, können Sie diese API verwenden, um das in der Appliance gespeicherte Administratorkennwort so zu aktualisieren, dass es dem im Active Directory-Domänenkonto konfigurierten Wert entspricht.
- API-Endpoint
-
Der Appliance-Endpoint zum Aktualisieren des gespeicherten Kennworts lautet
https://appliance-address/viewproxyadapter/local/config/rotate
Wobei appliance-address Folgendem entspricht:
- https://IP-address/viewproxyadapter/local/config/rotate, wobei IP-address die IP-Adresse der Appliance ist.
- https://FQDN/viewproxyadapter/local/config/rotate, wenn Sie die IP-Adresse der Appliance einem FQDN in Ihrem DNS-Server zugeordnet haben.
- API-Methode
- PUT
- Anforderungsnutzlast
-
Die Nutzlast erfordert den Active Directory-DNS-Domänennamen, den Kontonamen, das in der Appliance gespeicherte Kennwort (das vorherige Kennwort) und das neue Kennwort.
Bei den Kennwörtern müssen Sie jeden Buchstaben in Anführungszeichen setzen und die einzelnen Buchstaben durch Kommas trennen. Im folgenden Beispiel lautet das in der Appliance gespeicherte Kennwort abcd!efg und tuvw$xyz ist das neue Kennwort.
{ "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"] } - Wenn die API aufgerufen wird
-
Horizon Cloud Connector vergleicht die vorhandenen Anmeldedaten, die Sie in der API-Nutzlast angeben, mit den in der
Horizon Cloud Connector-Appliance gespeicherten Anmeldedaten.
Wenn die Validierung erfolgreich ist, versucht das System, sich mit den neuen Anmeldedaten, die in der API-Nutzlast angegeben sind, beim Horizon Connection Server anzumelden.
Wenn dieser Anmeldeversuch erfolgreich ist, laden die Dienste innerhalb der Appliance neu, um die neuen Anmeldedaten abzurufen und zu verwenden.
Hinweis: Diese API ist auf eine Anforderung pro Minute begrenzt. Wenn die Versuche die Ratenbegrenzung überschreiten, wird der HTTP-Fehler 429 (Zu viele Anforderungen) zurückgegeben. - API-Autorisierung
- Die Autorisierungsprüfung erfolgt durch den Vergleich von Domäne, Benutzername und altem Kennwort, die in der Anforderungsnutzlast angegeben sind, mit den Anmeldedaten, die Horizon Cloud Connector bekannt sind. Die bekannten Anmeldedaten sind entweder diejenigen, die während des Onboarding- und Kopplungsvorgangs oder während einer vorherigen Rotation der Anmeldedaten mithilfe dieser API bereitgestellt wurden.
Voraussetzungen
Überprüfen Sie die folgenden Elemente, bevor Sie den API-Befehl ausgeben.
- Horizon Cloud Connector wird mit dem Horizon-Pod und dem Horizon Connection Server des Pods gekoppelt.
- Sie verfügen über den DNS-Namen der Active Directory-Domäne und die Anmeldedaten des Horizon Connection Server-Administrators.
- In Ihrer Active Directory-Domäne haben Sie das Kennwort des Horizon Connection Server-Administratorkontos auf das neue Kennwort aktualisiert, das Sie verwenden möchten.
- Sie verfügen über das zuvor verwendete Kennwort, das der Horizon Cloud Connector-Appliance bekannt ist und das die Appliance derzeit verwendet.
Prozedur
- ♦Geben Sie ein PUT an den API-Endpoint https://appliance-address/viewproxyadapter/local/config/rotate mit der Anforderungsnutzlast aus.
Im folgenden Beispiel lautet die AD-Domäne example.com, der Name des Kontos ist CSadmin, das vorherige Kennwort ist abcd!efg und das neue Kennwort tuvw$xyz.
{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }Wenn die Kennwörter erfolgreich rotiert wurden, lautet die zurückgegebene Antwort 200 success.
