Configuração do aplicativo OAuth

Esta seção explica como configurar o aplicativo OAuth, independentemente do tipo de autenticação que você usa, seja Token interativo, Autenticação integrada do Windows, Nome de usuário e senha, ID e segredo do aplicativo ou ID e certificado do aplicativo.

Você pode usar o aplicativo público do UiPath (OAuthApplication = UiPath), que é o padrão, ou pode se registrar e usar seu próprio aplicativo do Azure (OAuthApplication = Custom):

• Registro de aplicativo público da UiPath: a vantagem de usar o aplicativo público da UiPath é que você não precisa configurar ou manter o aplicativo.

Observação:

A UiPath não armazena nenhum dado do usuário. O token de autenticação é salvo apenas na sua máquina ou no seu bucket do Orchestrator. Para obter mais detalhes, consulte Registro de aplicativo público da UiPath.

• Traga seu próprio aplicativo (BYOA): a vantagem de usar seu próprio aplicativo é que você pode gerenciar, personalizar e atribuir permissões dentro de sua organização de forma mais granular. Para obter mais detalhes, consulte Registro de aplicativo OAuth personalizado - Trazer seu próprio aplicativo (BYOA).

Registro do aplicativo público do UiPath

O UiPath Public App é registrado com as seguintes informações:

• Nome: UiPathStudioO365App
• ID do Cliente: f2f43f65-16a6-4319-91b6-d2a342a88744
• Escopos: Calendars.Read, Calendars.Read.Shared, Calendars.ReadWrite, Calendars.ReadWrite.Shared, Chat.ReadWrite, email, EWS.AccessAsUser.All, Files.Read, Files.Read.All, Files.ReadWrite, Files. ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Mail.Read, Mail.Read.Shared, Mail.ReadWrite, Mail.ReadWrite.Shared, Mail.Send, Mail.Send.Shared, offline_access, openid, Presença.Read, Presença.Read.All, perfil, Sites.Read.All, Sites.ReadWrite.All, User.Read, User.Read.All.

Registro do aplicativo OAuth personalizado – Traga seu próprio aplicativo (BYOA)

Esta seção explica como criar um aplicativo para as conexões do Microsoft 365 Scope .

Visão geral

Para habilitar as atividades Microsoft 365 Classic, seu aplicativo deve:

• ser integrada à plataforma de identidade da Microsoft.
• ter as permissões corretas da API do Microsoft Graph atribuídas a ela.

Depois de registrar seu aplicativo Microsoft 365, o Microsoft Entra ID atribui um ID exclusivo de aplicativo (cliente) que você insere na atividade Microsoft 365 Scope junto com os serviços aos quais você atribuiu permissões, que são arquivos, email e calendário.

Registrar seu próprio aplicativo (BYOA)

Dica:

Esse processo é descrito em detalhes na documentação da Microsoft em Início rápido: registre um aplicativo com a plataforma de identidade da Microsoft. No entanto, a interface do usuário da Microsoft pode ter sido alterada desde que essas etapas foram documentadas pela primeira vez.

1. Faça login no portal do Azure usando sua conta pessoal, profissional ou escolar do Microsoft 365.
2. Selecione Microsoft Entra ID.
3. Selecione o botão Adicionar e, na lista suspensa, selecione Registro de aplicativos.
4. Na página Registrar um aplicativo , preencha os seguintes campos Nome, Tipos de conta suportadas e Redirecionar URI (opcional).
5. No campo Nome , insira um nome para o seu aplicativo.
6. Em Tipos de contas compatíveis, selecione a opção que se aplica a você:
   • Apenas contas nesse diretório organizacional (apenas UiPath - Tenant único) - use essa opção se seu público-alvo for interno da sua organização. Isso representa um único aplicativo de tenant.
   • Contas em qualquer diretório organizacional (Qualquer tenant do Microsoft Entra ID - Multitenant) - use essa opção se seu público-alvo for clientes de negócios ou educacionais. Isso representa um aplicativo multitenant.
   • Contas em qualquer diretório organizacional (Qualquer tenant do Microsoft Entra ID - Multitenant) e contas pessoais da Microsoft (por exemplo, Skype, Xbox) - use essa opção para segmentar o conjunto mais amplo de identidades da Microsoft. Isso representa um aplicativo multitenant.
   • Apenas contas pessoais da Microsoft. Para obter mais informações sobre qual opção selecionar, consulte Quem pode fazer login no seu aplicativo?
7. Em URI de redirecionamento (opcional), insira um endereço de URI, se aplicável. A Biblioteca de autenticação da Microsoft (MSAL.NET) usa um URI de redirecionamento padrão: https://login.microsoftonline.com/common/oauth2/nativeclient. Esse valor provavelmente funcionará para você ao usar o tipo de autenticação de Token interativo.
   • Sua seleção depende do seu tipo de autenticação. Para obter mais detalhes, consulte Como se conectar às atividades do Microsoft 365).
   • Em nosso exemplo, a organização é compatível com a autenticação de vários tenants e só pode usar o tipo de autenticação Token interativo , que requer um URI de redirecionamento.
     • Se você usar Token interativo e o URI de redirecionamento padrão da Microsoft, você deve adicionar uma plataforma do tipo Aplicativos móveis e de desktop. Para obter mais detalhes, consulte Definir configurações de plataforma na documentação da Microsoft.
     • Se seu tipo de autenticação for autenticação integrada do Windows (IWA) ou nome de usuário e senha, você não precisará registrar um URI de redirecionamento para seu aplicativo. Esses fluxos fazem uma viagem de ida e volta para o ponto de extremidade da plataforma de identidade da Microsoft v2.0, e seu aplicativo não será chamado de volta em nenhum URI específico.
   • Ao trabalhar com o Microsoft 365 em um projeto do UiPath Studio que tem como alvo o .NET 5.0, adicione http://localhost ao URI de Redirecionamento dos aplicativos que você possui. Para obter mais detalhes, consulte Registro do aplicativo de área de trabalho na documentação da plataforma de identidade da Microsoft.
8. Selecione Registrar, que redireciona você para a página Visão geral do seu aplicativo registrado.

Para concluir a configuração do aplicativo, você também deve adicionar permissões de API a ele.

Observação:

Esta configuração é apenas um exemplo. Portanto, você pode fazer seleções com base nas políticas de sua organização.

Adicionar permissões de API

Observação:

• A autenticação de token interativo usa permissões delegadas.
• As permissões podem variar dependendo da atividade, pois cada atividade inclui as permissões de que precisa para suas funcionalidades específicas.

Após registrar seu aplicativo, adicione as permissões de API necessárias da seguinte forma:

1. No portal do Azure , acesse seu aplicativo registrado.

2. Expanda a opção Gerenciar e selecione Permissões de API.

3. Selecione Adicionar uma permissão, que abre o painel lateral Solicitar permissões de API .

4. Selecione Microsoft Graph, na guia APIs da Microsoft .

5. Selecione Permissões delegadas para mostrar a lista de permissões.

   Observação:

   • Permissões delegadas são usadas com o Token Interativo.
   • As permissões de aplicativos são usadas com o ID e o segredo do aplicativo.

   Para obter mais detalhes sobre tipos de permissão, consulte a documentação do Microsoft Azure sobre Como configurar um aplicativo cliente para acessar APIs da web .

6. Use a barra de pesquisa ou role a lista para baixo e selecione as seguintes permissões:

   Observação:

   • As permissões podem variar dependendo da atividade, pois cada atividade inclui as permissões de que precisa para suas funcionalidades específicas.
   • Essas permissões não são todas obrigatórias. A lista a seguir representa o conjunto completo de permissões necessárias para executar todas as atividades Microsoft 365. Você pode restringir permissões dependendo do seu caso de uso específico. Verifiqueas páginas de documentação de atividades para saber de quais permissões elas precisam.
   • Calendário
     • Calendários.Leia
     • Calendários.ReadWrite
   • Arquivos
     • Arquivos.Read
     • Arquivos.Ler.Todos
     • Arquivos.ReadWrite
     • Arquivos.ReadWrite.All
   • Sites
     • Sites.Read.All
     • Sites.ReadWrite.All
   • Email
     • Mail.Read
     • Mail.ReadWrite
     • E-mail.Enviar
   • Usuários
     • User.Read
   • Compartilhado - escopos necessários para acessar recursos compartilhados com o usuário, mas que não são de propriedade dele.
     • Mail.Read.Shared
     • Mail.ReadWrite.Shared
     • Mail.Enviar.Compartilhado
     • Calendars.Read.Shared
     • Calendars.ReadWrite.Shared

7. Selecione Adicionar permissões para retornar à sua lista de Permissões de API.

8. Certifique-se de que suas Permissões de API incluam suas permissões de Calendários, Arquivos, Usuário e Email adicionadas.

Restringir um aplicativo a sites específicos

Se você quiser controlar quais sites seu aplicativo pode acessar, proceda da seguinte maneira:

Primeiro, atribua a permissão Sites.Selected ao seu aplicativo:

1. No portal do Azure , acesse seu aplicativo registrado.
2. Expanda a opção Gerenciar e selecione Permissões de API.
3. Selecione Adicionar uma permissão, que abre o painel lateral Solicitar permissões de API .
4. Na guia APIs da Microsoft , selecione Microsoft Graph.
5. Selecione Permissões de aplicativos.
6. Pesquise sites e expanda o menu suspenso Sites para exibir todas as permissões de sites disponíveis.
7. Adicione uma marca de seleção ao lado da permissão Sites.Selected e, em seguida, selecione Adicionar permissão.

Em seguida, permita que o aplicativo acesse um site específico usando APIs:

1. Acesse o explorador do Microsoft Graph.
2. Crie uma API do tipo GET. Por exemplo, https://graph.microsoft.com/v1.0/sites?search=FPH_Test, onde FPH_Test é o nome de um site do SharePoint.

Figura 1. Página do Microsoft Graph Explorer com a API GET

3. Selecione Executar consulta.
4. Copie o ID do site 6c964666-500d-48e6-9ca6-84acee41c5b9,f955b6bc-9d48-4155-b1f5-e722d5cea1b5 do corpo da resposta e cole-o em um documento para uso posterior.

Figura 2. O corpo de resposta GET da API no Explorador do Microsoft Graph

5. Para permitir que o aplicativo acesse esse site, crie outra API, desta vez do tipo POST. Por exemplo, https://graph/microsoft.com/v1.0/sites/0yxd4.sharepoint.com,6c964666-500d-48e6-9ca6-84acee41c5b9,f955b6bc-9d48-4155-b1f5-e722d5cea1b5/permissions, onde 6c964666-500d-48e6-9ca6-84acee41c5b9,f955b6bc-9d48-4155-b1f5-e722d5cea1b5 é a ID do site.

6. Como esta é uma API POST, insira os dados da carga útil no formato JSON no corpo da solicitação. Por exemplo:

   {
   	"roles": [
   		"write"
   	],
   	"grantedToIdentities": [
   		{
   			"application": {
   				"id": "14dbd4c1-9ebf-47e8-c3f75bffed2d",
   				"displayName": "BOYA_Nisarg"
   			}
   		}
   	]
   }
   

   Observação:

   • Certifique-se de que a carga contenha o nome e o ID do aplicativo.
   • Você pode encontrar o ID do aplicativo quando acessa o aplicativo no Azure, em Visão geral.

7. Selecione Executar consulta. Se a consulta tiver sido executada com sucesso, a mensagem Criado - 201 será exibida.

Para verificar quais aplicativos podem acessar sites específicos, altere a API de POST para GET, remova a carga, mantenha a mesma API e execute a consulta. Você pode encontrar no corpo da resposta todos os aplicativos que podem acessar esse site específico.