Cette page de documentation décrit l'API à utiliser lorsque vous effectuez la rotation du mot de passe de l'administrateur Horizon Connection Server dans votre système Active Directory. Dans ce cas d'utilisation, utilisez cette API pour qu'Horizon Cloud Connector utilise la nouvelle valeur.
Cette fonctionnalité est compatible avec Horizon Cloud Connector version 2.4 et ultérieures.
Horizon Cloud Connector utilise les informations d'identification de l'administrateur entrées lors du processus d'intégration et de couplage pour communiquer avec Horizon Connection Server.
Au fil du temps, ces informations d'identification de l'administrateur peuvent changer dans votre domaine Active Directory, ou elles expirent, voire deviennent non valides. Si le dispositif Horizon Cloud Connector n'est pas informé des nouvelles informations d'identification lorsque les informations d'identification de l'administrateur sont mises à jour dans le domaine Active Directory, Horizon Cloud Connector perd la connectivité avec Horizon Connection Server.
Lorsque vous devez mettre à jour le mot de passe de l'administrateur, vous pouvez utiliser cette API pour mettre à jour le mot de passe d'administrateur stocké dans le dispositif pour qu'il corresponde à la valeur configurée dans le compte de domaine Active Directory.
- Point de terminaison d'API
-
Le point de terminaison du dispositif pour la mise à jour du mot de passe stocké est
https://appliance-address/viewproxyadapter/local/config/rotate
Où appliance-address est l'un des éléments suivants :
- https://IP-address/viewproxyadapter/local/config/rotate, où IP-address est l'adresse IP du dispositif.
- https://FQDN/viewproxyadapter/local/config/rotate, si vous avez mappé l'adresse IP du dispositif à un nom de domaine complet dans votre serveur DNS.
- Méthode d'API
- PUT
- Charge utile de la demande
-
La charge utile nécessite le nom de domaine DNS Active Directory et le mot de passe stocké dans le dispositif (le mot de passe précédent) et le nouveau mot de passe.
Pour les mots de passe, mettez chaque lettre entre guillemets et séparez les lettres par des virgules. Dans l'exemple suivant, le mot de passe stocké dans le dispositif est abcd!efg et le nouveau mot de passe est 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"] } - Lorsque l'API est appelée
-
Horizon Cloud Connector compare les informations d'identification existantes que vous fournissez dans la charge utile de l'API avec les éléments stockés dans le dispositif
Horizon Cloud Connector.
Si la validation réussit, le système tente de se connecter à Horizon Connection Server à l'aide des nouvelles informations d'identification fournies dans la charge utile de l'API.
Si cette tentative de connexion réussit, les services dans le dispositif se rechargent pour récupérer les nouvelles informations d'identification et commencer à les utiliser.
Note : Le débit de cette API est limité à une demande par minute. Si les tentatives dépassent la limite de débit, l'erreur HTTP 429 (Trop de demandes) est renvoyée. - Autorisation de l'API
- La vérification de l'autorisation s'effectue en comparant les paramètres domain, userName et oldPassword fournis dans la charge utile de la demande avec les informations d'identification connues d' Horizon Cloud Connector. Les informations d'identification connues sont celles qui ont été fournies lors du processus d'intégration et de couplage ou lors d'une rotation des informations d'identification antérieure à l'aide de cette API.
Conditions préalables
Avant d'émettre la commande API, vérifiez les éléments suivants.
- Horizon Cloud Connector est couplé avec l'espace Horizon, avec l'instance d'Horizon Connection Server de l'espace.
- Vous disposez du nom DNS du domaine Active Directory et des informations d'identification de l'administrateur Horizon Connection Server.
- Dans votre domaine Active Directory, vous avez mis à jour le mot de passe du compte de l'administrateur Horizon Connection Server avec le nouveau mot de passe que vous souhaitez utiliser.
- Vous disposez du mot de passe utilisé précédemment, celui qui est connu du dispositif Horizon Cloud Connector et que ce dernier utilise actuellement.
Procédure
- ♦Émettez une requête PUT au point de terminaison d'API https://appliance-address/viewproxyadapter/local/config/rotate avec la charge utile de la demande.
Dans l'exemple suivant, le domaine AD est example.com, le compte est nommé CSadmin, le mot de passe précédent est abcd!efg et le nouveau mot de passe est tuvw$xyz.
{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }Lorsque la rotation des mots de passe est effectuée, la réponse renvoyée est 200 success.
