Ir para conteúdo principal

Criando e gerenciando clientes OAuth

O OAuth é um protocolo de segurança padrão para autorização e delegação. Ele permite que aplicativos de terceiros acessem recursos da API sem revelar as credenciais do usuário final. Um cliente OAuth pode obter um código de autorização e trocá-lo por um token de acesso que pode ser usado para acessar APIs do Qlik Cloud.

Os clientes OAuth são administrados por administradores de locatários na página OAuth do Management Console.

Nota do Qlik Sense Enterprise SaaS GovernmentO Qlik Sense Enterprise SaaS - Government (US) não oferece suporte a clientes OAuth. Para mais informações, consulte Confiança e segurança na Qlik.

Criando um cliente OAuth

Um cliente OAuth permite que você integre seu aplicativo cliente com o Qlik Cloud.

Faça o seguinte:

  1. No Management Console, acesse a seção Integração e selecione OAuth. Clique em Criar novo.
  2. No diálogo, atribua um nome ao cliente OAuth.

  3. Insira a URL de redirecionamento para o aplicativo cliente OAuth. O Qlik Cloud irá redirecionar o usuário de volta ao aplicativo após uma autorização bem-sucedida apenas se sua URL estiver na lista de permissão de URLs de redirecionamento. As URLs devem começar com https://, a menos que o domínio seja localhost, nesse caso, pode começar com http://.

    Clique em Adicionar para adicionar a URL de redirecionamento à lista de permissões.

    Nota informativaVocê pode adicionar mais de uma URL.
  4. Clique em Criar.
  5. Clique em Copiar para a área de transferência para salvar o ID do cliente e o segredo do cliente para uso posterior. Guarde o segredo do cliente em um local seguro. Clique em Concluído.

Editando um cliente OAuth

Você pode renomear um cliente OAuth, atualizar a descrição ou gerenciar as URLs de redirecionamento.

Faça o seguinte:

  1. No Management Console, acesse a seção Integração e selecione OAuth. Selecione o cliente OAuth que você deseja editar. Clique em ... e selecione Editar.
  2. No diálogo, altere as opções do cliente OAuth conforme necessário.
  3. Clique em Salvar.

Publicando um cliente OAuth

Os clientes OAuth criados são automaticamente vinculados ao locatário que o criou. Você pode configurar um cliente OAuth para ser compartilhado e disponibilizado para todos os outros locatários em uma região. Aplicativos de terceiros que se conectam ao Qlik Cloud podem ter o mesmo ID de cliente para todos os locatários do Qlik Cloud. O proprietário do aplicativo pode alternar segredos e atualizar a configuração sem a interação de um administrador de locatários. Os administradores de locatários não precisarão gerenciar credenciais ou conhecer detalhes de configuração.

Para permitir que outros locatários se conectem a um cliente OAuth, este precisa ser publicado.

Faça o seguinte:

  1. No Management Console, na seção OAuth, selecione o cliente OAuth que você deseja publicar. Clique em ... e selecione Publicar.
  2. Clique em Publicar.

Quando um usuário navega para um site externo que usa o Qlik OAuth, ele é solicitado a fornecer o nome de host de locatário e, posteriormente, também as credenciais de usuário, a menos que ele já tenha um sessão ativa do SaaS. O primeiro login com um cliente OAuth externo requer o consentimento de um administrador de locatário. Quando aprovado, o novo cliente OAuth é mostrado no Management Console.

Método de consentimento

Existem duas opções de consentimento: obrigatório e confiável. Com obrigatório, a autorização usando o cliente OAuth solicitará o consentimento sempre que um novo escopo for solicitado para o usuário. Com confiável, o usuário não precisa dar seu consentimento.

Como visualizar e copiar a configuração OAuth

Na seção OAuth do Management Console, selecione Exibir configuração do OAuth para exibir a configuração como um trecho de código e uma URL a ser copiada.

Excluindo um cliente OAuth

Você pode excluir um cliente OAuth quando ele não for mais necessário ou para revogar o acesso.

Faça o seguinte:

  1. No Management Console, acesse a seção Integração e selecione OAuth. Selecione o cliente OAuth que você deseja remover e clique em Excluir.

    Nota informativaVocê pode remover mais de um cliente OAuth por vez.
  2. Confirme que você deseja excluir o cliente OAuth.

Gerenciando segredos do cliente

Pode ser necessário adicionar ou remover um segredo do cliente se, por exemplo, um segredo do cliente for comprometido ou sua política de segurança exigir que você atualize periodicamente o segredo do cliente. Você também pode adicionar vários segredos de cliente para evitar o tempo de inatividade no aplicativo. Por exemplo, você pode criar um segundo segredo, implantar o novo segredo em seu aplicativo cliente e, em seguida, excluir o segredo antigo.

Faça o seguinte:

  1. No Management Console, acesse a seção Integração e selecione OAuth. Selecione o cliente OAuth que você deseja gerenciar. Clique em ... e selecione Gerenciar segredos.
  2. No diálogo, siga um destes procedimentos:
    • Para adicionar um novo segredo do cliente, clique em Gerar um novo segredo do cliente.
    • Para remover um segredo de cliente, clique em Excluir ao lado do segredo do cliente.
  3. Clique em Fechar.

Criar um aplicativo cliente OAuth para acessar o Qlik Cloud

Depois de registrar um cliente OAuth no Qlik Cloud, você pode usar o ID do cliente e o segredo do cliente associados em seu próprio aplicativo cliente OAuth. Tutoriais estão disponíveis na seção Bibliotecas OAuth do portal do Developer para construir aplicativos cliente usando algumas das linguagens de codificação mais populares.