Criar a conexão de OAuth

Um administrador da Control Room pode criar conexões OAuth para os usuários usarem essas conexões na ação de autenticação para pacotes sem terem que inserir qualquer detalhe de autenticação.

Observação: A marca e o logotipo Salesforce, a marca e o logotipo Microsoft SharePoint, a marca e o logotipo Apigee, a marca e o logotipo ServiceNow e a marca e o logotipo Genesys são marcas comerciais ou marcas registradas Salesforce, Inc., Microsoft Corp., Google LLC, ServiceNow, Inc. e Genesys, respectivamente, e são usados apenas para fins de identificação.

Pré-requisitos

  • Certifique-se de usar uma função de usuário que tenha a permissão Gerenciar conexões habilitada para o recurso Conexões OAuth. Consulte Permissões de recurso para uma função.
  • Verifique se você configurou um aplicativo corporativo e anotou o ID do cliente, o segredo do cliente, o URL de autorização, o URL do token e o escopo. Consulte Configurar aplicativos corporativos
    Nota: Considere os pré-requisitos acima para evitar um erro de conexão.
    Aplicativos enterprise URL de autorização URL do token Escopo
    Apigee https://accounts.google.com/o/oauth2/auth?prompt=consent&access_type=offline https://accounts.google.com/o/oauth2/token https://www.googleapis.com/auth/cloud-platform
    Genesys https://login.<yourinstance>.pure.cloud/oauth/authorize https://login.<yourinstance>.pure.cloud/oauth/token Não é necessário
    Google Workspace (Agenda, Drive, Planilhas e Gmail) https://accounts.google.com/o/oauth2/auth?prompt=consent&access_type=offline https://oauth2.googleapis.com/token
    • Google Sheets: https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/spreadsheets
    • Google Drive: https://www.googleapis.com/auth/drive
    • Google Calendar: https://www.googleapis.com/auth/calendar
    • Gmail : https://developers.google.com/identity/protocols/oauth2/scopes#gmail

      https://mail.google.com/,https://www.googleapis.com/auth/gmail.readonly,https://www.googleapis.com/auth/gmail.send
    Microsoft Entra https://login.microsoftonline.com/<tenant>/oauth2/v2.0/authorize https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token Fluxo do código de autorização: offline_access, openid
    OR
    Fluxo de credenciais do cliente: https://graph.microsoft.com/.default
    Microsoft 365 Outlook https://login.microsoftonline.com/<tenant>/oauth2/v2.0/authorize https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token Fluxo do código de autorização: offline_access, openid, https://graph.microsoft.com/.default
    Salesforce https://<yourinstance>.salesforce.com/services/oauth2/authorize https://<yourinstance>.salesforce.com/services/oauth2/token api,refresh_token,offline_access
    ServiceNow https://<yourinstance>.service-now.com/oauth_auth.do https://<yourinstance>.service-now.com/oauth_token.do Não é necessário
    SharePoint https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token https://<domain-name>/AllSites.Manage, offline_access, openid
    Nota: O escopo do OpenID é necessário somente quando seus aplicativos exigem a sub-reivindicação no token de ID para identificar o usuário final. Caso contrário, esse escopo é opcional.
Nota: Recomendamos usar tokens de atualização configurados para uma duração mais longa. Consulte Utilizar o aplicativo AuthConfig para ativar os serviços OAuth2.

Procedimento

  1. Na Control Room, navegue até Gerenciar > Conexões OAuth.
  2. Clique em Criar conexão.
  3. Na tela Configurações de conexão que é aberta, selecione um Tipo de provedor.
    Nota: O URL de retorno de chamada é usado nas definições de configuração dos aplicativos empresariais para conectar-se à Control Room.
  4. Digite um Nome de conexão exclusivo para identificar a conexão.
  5. Opcional: Digite uma Descrição para a conexão.
    Imagem exibindo a página de configurações da conexão OAuth
  6. Clique em Avançar.
    A tela Detalhes da autenticação é exibida.
  7. Selecione um Tipo de concessão. Consulte Fluxo de código de autorização OAuth e Fluxo de credenciais do cliente OAuth.
    Nota: Se você estiver configurando uma conta do Google Cloud Platform (GCP), selecione Fluxo do código de autorização porque a conexão OAuth gerenciada pela Control Room que usa o Fluxo do código de autorização com PKCE não é suportada no momento.
  8. Digite o ID do cliente fornecido pelo provedor para sua conta.
  9. Digite o Segredo do cliente que é fornecido pelo provedor para sua conta.
    Nota:
    • Após testar ou criar uma conexão, o campo do Segredo do cliente não será exibido na interface do usuário, mas o serviço de back-end continuará a usar o valor armazenado. Este é um comportamento esperado.
    • O campo do Segredo do cliente fica mascarado enquanto você insere o valor, como um campo de senha. Isso aumenta a segurança ao impedir que o segredo fique visível em texto simples.
  10. Digite o URL de autorização usado para obter o código de autorização de sua conta.
    Nota: Para a conta Apigee ou Google Cloud Platform (GCP), você deve acrescentar &access_type=offline ao URL de autorização. Por exemplo: https://accounts.google.com/o/oauth2/v2/auth?prompt=consent&access_type=offline.
  11. Digite o URL do token usado para trocar um código de autorização por um token de acesso.
  12. Opcional: Digite Escopo.
    Imagem exibindo a página de detalhes da autenticação OAuth
    Essas informações são usadas como reivindicações (informações sobre o usuário) em um token de acesso e encaminhadas ao servidor de recursos para limitar o acesso.
    Nota: Se estiver adicionando mais de um escopo, certifique-se de separar os escopos usando vírgulas ou delimitadores separados por espaço.
  13. Clique em Avançar.
    A tela Testar conexão e salvar credenciais é exibida.
  14. Opcional: Selecione a opção Salvar credenciais de login.
    Nota: Use essa opção apenas quando desejar gerar um token compartilhado que permita aos usuários usar essa conexão sem fornecer autenticação e consentimento do usuário. Ao selecionar essa opção, você precisa selecionar a opção do tipo de token Compartilhado ao usar essa conexão. Consulte .
  15. Opcional: Clique em Salvar alterações e testar a conexão.
    Imagem exibindo a página de conexão de teste OAuth e de credenciais salvas
    Nota: Depois de clicar na opção Salvar alterações e testar conexão e se a conexão tiver êxito, o botão Avançar será desabilitado. Clique no botão Voltar, digite o Segredo do cliente novamente e clique em Avançar. Não é necessário testar a conexão novamente, a menos que você tenha feito alguma alteração nos detalhes de autenticação fornecidos anteriormente.
  16. Clique em Avançar.
    A tela Convidar funções é exibida.
  17. Selecione as funções que você deseja convidar para usar essa conexão. Apenas as funções convidadas podem usar o token em um bot, seja ele privado ou compartilhado.Imagem exibindo a página de funções de convite do OAuth

    A ação Convidar funções é obrigatória quando um Bot usa a conexão OAuth. Essa ação é opcional se um serviço externo for usar a conexão OAuth.

    Nota: Somente funções personalizadas são exibidas na lista de Funções disponíveis.
  18. Clique em Criar conexão. Uma conexão OAuth é criada.

O vídeo a seguir mostra como criar uma conexão OAuth:

Próximas etapas

Usar conexão OAuth