Gerenciamento de aplicativos externos do OAuth

Como administrador, usando a estrutura do OAuth, você pode delegar autorização para aplicativos externos. Depois de serem registrados, esses aplicativos podem fazer chamadas de API para aplicativos ou recursos da UiPath no escopo das APIs que você designar.

Adição de um aplicativo externo

Para registrar um aplicativo externo, de forma que ele possa usar o OAuth para acessar seus recursos da UiPath:

1. Faça login no tenant como Administrador para acessar o portal de gerenciamento no nível do tenant.
2. Selecione Aplicativos externos.
3. Clique em Adicionar aplicativo na parte superior direita.
4. Preencha o campo Application Name
5. Selecione uma opção para o Tipo de aplicativo.

   Se você selecionar Aplicativo confidencial, receberá um segredo do aplicativo no final, portanto, certifique-se de que seu aplicativo pode armazená-lo com segurança. Se não for possível, selecione Aplicativo não confidencial.

6. Em Recursos, clique em Adicionar escopos.

   O painel Editar recurso será aberto à direita, no qual você pode selecionar os recursos que o aplicativo deve ter acesso.

7. Na lista suspensa Recurso, selecione a API do UiPath que o aplicativo pode usar.
   Nota: Você só pode adicionar escopo para um recurso por vez. Se você quiser permitir acesso a vários recursos, repita esse processo para adicionar escopo para cada recurso.
8. Na guia Escopo(s) do usuário, marque as caixas de seleção para as permissões de API lógica que você deseja conceder, conforme necessário.

   A concessão de permissões no escopo do usuário significa que o aplicativo externo pode acessar esses recursos dentro de um contexto de usuário e um usuário com as permissões adequadas deve estar logado.

9. Se esse for um aplicativo confidencial, você pode alternar para a guia Escopo(s) do aplicativo para também conceder permissões de nível de aplicativos para o recurso selecionado, conforme necessário.

   Com permissões sob o escopo do aplicativo, o aplicativo externo tem acesso aos dados de nível de aplicativo dos escopos selecionados sem a necessidade de interação do usuário.

   Os aplicativos não confidenciais não podem acessar o escopo do aplicativo.

10. Clique em Salvar.

    O painel será fechado e o recurso e os escopos selecionados serão adicionados à tabela Recursos no formulário.

11. Se o aplicativo externo tiver sido registrado com os escopos do usuário, você deve adicionar uma URL de redirecionamento onde o aplicativo externo deve receber a resposta de autorização.

    Se apenas os escopos de aplicativos forem selecionados, fornecer uma URL de redirecionamento é opcional.

12. Clique em Adicionar para criar o registro.

    Uma mensagem de confirmação será aberta. Para aplicativos confidenciais, a mensagem de confirmação inclui o segredo do aplicativo que o aplicativo externo registrado pode usar para solicitar autorização. Certifique-se de salvá-lo em um local seguro porque não poderá exibi-lo novamente.

Alteração do escopo de um aplicativo existente

Escopos são as permissões do aplicativo externo em relação a um recurso da UiPath.

1. Faça logon no tenant como um Administrador.
2. Acesse Tenant > Gerenciar acesso > Atribuir funções e clique em Gerenciar contas e grupos.

   O Portal de gerenciamento no nível do tenant será aberto.

3. À esquerda, selecione Aplicativos externos.

   A página Aplicativos externos é aberta, listando todos os aplicativos externos existentes registrados para o tenant atual:

4. Clique em Editar à direita da linha do aplicativo.
5. Altere o escopo para o qual o aplicativo tem acesso:
   1. Use os ícones à direita de uma linha de recurso para editar o escopo existente ou para excluir o recurso.
   2. Clique em Adicionar escopos para adicionar um recurso adicional e selecione escopos para ele.
6. Clique em Salvar.

Geração de um novo segredo do aplicativo

Se você não souber o segredo do aplicativo que foi gerado para um aplicativo externo confidencial, você não poderá recuperá-lo. Mas você pode gerar um novo.

Nota: Se você gerar um novo segredo do aplicativo, certifique-se de compartilhá-lo com o desenvolvedor que está mantendo a integração com o aplicativo externo. Eles devem atualizar o mecanismo de autenticação; caso contrário, a integração existente não funcionará mais.

Para gerar um novo segredo do aplicativo:

1. Faça logon no tenant como um Administrador.
2. Acesse Tenant > Gerenciar acesso > Atribuir funções e clique em Gerenciar contas e grupos.

   O Portal de gerenciamento no nível do tenant será aberto.

3. À esquerda, selecione Aplicativos externos.

   A página Aplicativos externos é aberta, listando todos os aplicativos externos existentes registrados para o tenant atual:

4. Clique em Editar ícone à direita da linha do aplicativo.
5. Em Segredo do aplicativo, clique em Gerar novo.

   Um novo segredo do aplicativo será gerado e exibido acima do botão. Ele permanecerá visível até você clicar em Cancelar para fechar a página.

6. Copie o segredo do aplicativo e certifique-se de armazená-lo em um local seguro.

Fornecimento de detalhes aos desenvolvedores

Após você registrar um aplicativo externo, um desenvolvedor também deve configurar o aplicativo externo para que ele autentique devidamente, solicite a autorização do UiPath Identity Server e acesse os recursos permitidos da UiPath.

Para poder realizar essas tarefas, você deve compartilhar as seguintes informações com eles:

• o Tipo de aplicativo e o ID do aplicativo, ambos estão visíveis na página Administrador > Aplicativos externos
• os escopos adicionados para cada tipo de escopo. Para alguns recursos, o mesmo nome é usado sob os escopos de usuários e de aplicativos, portanto, o tipo também é importante.

• Se esse for um aplicativo confidencial, o segredo do aplicativo é gerado ao registrar o aplicativo externo.

  Observação: se você não tiver mais o segredo, gere um novo conforme descrito acima.

Para obter mais detalhes sobre como autenticar e autorizar aplicativos externos como desenvolvedor, consulte Aplicativos externos no guia de API.