Essa página de documentação descreve a API a ser usada quando você está alternando a senha do administrador do Horizon Connection Server em seu sistema Active Directory. Nesse caso de uso, você usa essa API para que o Horizon Cloud Connector use o novo valor.
Este recurso tem suporte para uso com o Horizon Cloud Connector versão 2.4 e posterior.
O Horizon Cloud Connector usa as credenciais de administrador inseridas durante o processo de integração e emparelhamento para se comunicar com o Horizon Connection Server.
Com o tempo, essas credenciais de administrador podem ser alteradas no seu domínio Active Directory ou expiradas ou se tornam inválidas. Se o dispositivo do Horizon Cloud Connector não for informado sobre as novas credenciais quando as credenciais do administrador forem atualizadas no domínio do Active Directory, o Horizon Cloud Connector perderá a conectividade com o Horizon Connection Server.
Quando precisar atualizar a senha do administrador, você poderá usar essa API para atualizar a senha do administrador armazenada no dispositivo para corresponder ao valor configurado na conta de domínio do Active Directory.
- Endpoint de API
-
O endpoint do dispositivo para atualizar a senha armazenada é
https://appliance-address/viewproxyadapter/local/config/rotate
Em que appliance-address é um dos seguintes:
- https://IP-address/viewproxyadapter/local/config/rotate, em que IP-address é o endereço IP do dispositivo.
- https://FQDN/viewproxyadapter/local/config/rotate, se você mapeou o endereço IP do dispositivo para um FQDN no seu servidor DNS.
- Método de API
- PUT
- Solicitar payload
-
O payload requer o nome de domínio DNS, o nome da conta, a senha armazenada no dispositivo (a senha anterior) e a nova senha.
Para as senhas, enrole cada letra entre aspas e separe as letras encapsuladas com vírgulas. No exemplo a seguir, a senha armazenada no dispositivo é abcd!efg, e tuvw$xyz é a nova senha.
{ "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"] } - Quando a API é invocada
-
O
Horizon Cloud Connector compara as credenciais existentes que você fornece no payload da API com o que está armazenado no dispositivo do
Horizon Cloud Connector.
Se a validação for bem-sucedida, o sistema tentará fazer login no Horizon Connection Server usando as novas credenciais fornecidas no payload da API.
Se essa tentativa de login for bem-sucedida, os serviços no dispositivo serão recarregados para obter as novas credenciais e começar a usá-las.
Observação: Essa API é limitada a uma solicitação por minuto. Se as tentativas excederem o limite de taxa, o erro HTTP 429 (muitas solicitações) será retornado. - Autorização da API
- A verificação de autorização é feita comparando o domínio, userName e oldPassword fornecidos no payload da solicitação com as credenciais que são conhecidas pelo Horizon Cloud Connector. As credenciais conhecidas são aquelas que foram fornecidas durante o processo de integração e emparelhamento ou durante uma rotação de credenciais anterior usando essa API.
Pré-requisitos
Antes de emitir o comando da API, verifique os seguintes itens.
- O Horizon Cloud Connector está emparelhado com o pod do Horizon, com o Horizon Connection Server do pod.
- Você tem o nome DNS do domínio do Active Directory e as credenciais de administrador do Horizon Connection Server.
- Em seu domínio do Active Directory, você atualizou a senha da conta de administrador do Horizon Connection Server para a nova senha que deseja usar.
- Você tem a senha usada anteriormente, a existente que é conhecida pelo dispositivo do Horizon Cloud Connector, que o dispositivo está usando no momento.
Procedimento
- ♦Emita um PUT para o endpoint da API https://appliance-address/viewproxyadapter/local/config/rotate com o payload de solicitação.
No exemplo a seguir, o domínio do AD é example.com, a conta é nomeada como CSadmin, a senha anterior é abcd!efg e a nova senha é tuvw$xyz.
{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }Quando as senhas são alternadas com sucesso, a resposta retornada é 200 êxito.
