Pré-requisitos do conector Microsoft SharePoint 365

Introdução

Para usar o conector Microsoft SharePoint 365, é necessário ter um aplicativo Microsoft SharePoint 365, suas credenciais e certas permissões configuradas. Este documento descreve como criar um aplicativo e obter suas credenciais para ambos os tipos de autenticação disponíveis na conexão (Serviço de Controle de Acesso do Azure ou Microsoft Entra ID).

Consulte a documentação da Microsoft para obter informações sobre como atualizar seu aplicativo SharePoint existente do Serviço de Controle de Acesso do Azure para o Microsoft Entra ID.

Microsoft Entra ID

Esta seção descreve como registrar um aplicativo usando o Microsoft Entra ID, definir suas permissões e gerar uma afirmação de cliente.

Etapas de registro do aplicativo Microsoft Entra ID

Siga estas etapas para criar um registro de aplicativo com a plataforma de identidade da Microsoft:

1. No portal do Azure, pesquise e clique em Microsoft Entra ID (anteriormente conhecido como Azure Active Directory ou Azure AD):

   

2. No menu à esquerda, sob Gerenciar, clique em Registros de aplicativos.

3. Clique em Novo registro:

   

4. Insira um Nome para seu aplicativo. Este nome de exibição será visível para os usuários:

   

5. Clique em Registrar para concluir o registro do aplicativo. Você será direcionado para a página Visão geral do aplicativo:

   

   Importante

   Retenha o ID do aplicativo (cliente) e o ID do diretório (inquilino) do registro do aplicativo para usar como ID do cliente e ID do inquilino ao configurar uma conexão.

Adicionar permissões necessárias ao registro do aplicativo

Seu registro de aplicativo deve ter um conjunto específico de permissões.

No portal do Azure, navegue até seu registro de aplicativo e clique em Permissões de API na barra lateral esquerda:

Para adicionar permissões de aplicativo do Microsoft SharePoint, siga estas etapas:

1. Na página Permissões de API, clique em Adicionar uma permissão.

2. No painel Solicitar permissões de API, clique na guia APIs que minha organização usa, pesquise e clique em SharePoint.

3. Clique em Permissões de aplicativo.

4. Ative a permissão Sites.FullControl.All.

5. Clique em Adicionar permissões. A página Permissões configuradas do registro de aplicativo atualizado é exibida.

Gerar a asserção do cliente

Siga estas etapas para gerar uma asserção do cliente (necessária para configuração da conexão):

1. Crie um certificado autoassinado seguindo as instruções a seguir:

   Salve o script do PowerShell fornecido pela Microsoft chamado Create-SelfSignedCertificate.ps1 em sua máquina.

Dentro do PowerShell, vá para o diretório onde o script foi salvo e execute este script (como administrador):

.\Create-SelfSignedCertificate.ps1 -CommonName "<Digite um nome para o certificado, exemplo: MyCert>" -StartDate <Digite uma data de início do certificado no formato de data ISO: 2024-10-01> -EndDate <Digite uma data de expiração do certificado no formato ISO: 2029-10-01>

Substitua o texto de espaço reservado (incluindo os sinais de menor < >) pelos valores apropriados para o seu caso de uso.

Após executar o script, você será solicitado a fornecer uma senha para criptografar sua chave privada, e tanto o arquivo .PFX quanto o arquivo .CER serão exportados para o diretório atual.

1. Faça o upload do certificado autoassinado para o registro do aplicativo:

   Na página de visão geral do registro do seu aplicativo, clique em Adicionar um certificado ou segredo e depois clique em Fazer upload do certificado e selecione o arquivo .CER gerado no passo 1.

   Após fazer o upload do certificado, mantenha o valor na coluna Thumbprint para o certificado. Converta o thumbprint hexadecimal em uma string codificada em Base64 e remova quaisquer caracteres =.

2. Gere um arquivo .PEM a partir do arquivo .PFX gerado (do passo 1) com este script no PowerShell (como administrador):

openssl pkcs12 -in <Digite o nome do arquivo .PFX gerado>.pfx -out private.pem -nodes

Substitua o texto de espaço reservado (incluindo os sinais de menor < >) pelos valores apropriados.

Mantenha o valor private_key do arquivo .PEM gerado (para ser usado no passo 4).

1. Gere a afirmação do cliente. Os passos a seguir mostram como fazer isso usando jwt.io.

   Dica

   A afirmação do cliente também pode ser gerada em um script Jitterbit usando a CreateJwtToken function.

   No jwt.io, selecione RS256 como Algoritmo e configure o Cabeçalho, Carga e Verificar assinatura.

   Insira o Cabeçalho neste formato:

   Cabeçalho

   {
    "alg": "RS256",
    "typ": "JWT",
    "x5t":"<Enter the Base64-encoded thumbprint obtained in step 2>"
   }
   

   Substitua o texto de espaço reservado (incluindo os sinais de menor e maior < >) pelo valor apropriado.

   Insira o Payload neste formato:

   Payload

   {
    "aud": "https://login.microsoftonline.com/<tenantId>/oauth2/v2.0/token",
    "exp": <an expiration time>,
    "iss": "<client ID>",
    "jti": "<a GUID>",
    "nbf": <a "not before" claim>,
    "iat": <an "issued at" claim>,
    "sub": "<client ID>"
   }
   

   Substitua o texto de espaço reservado (incluindo os sinais de menor e maior < >) pelo valor apropriado para seu caso de uso. Para mais informações sobre esses campos, consulte a documentação da Microsoft.

   Na seção Verificar assinatura, insira a private_key (obtida na etapa 3) para o registro do aplicativo.

   Uma vez que as seções Header, Payload e Verificar assinatura tenham sido configuradas, o valor gerado na seção Encoded é o valor a ser usado como a Client assertion na configuração de conexão.

Serviço de Controle de Acesso do Azure (Descontinuado)

Esta seção descreve como criar um aplicativo usando o modelo de Add-in do SharePoint e o Serviço de Controle de Acesso do Azure (ACS) e definir suas permissões. Os passos para autenticar com o Microsoft Entra ID estão descritos na próxima seção.

Criar um aplicativo

Estas são as instruções para criar um aplicativo:

1. Faça login na instância do Microsoft SharePoint.

2. Uma vez logado, navegue até esta URL (substituindo <office_365_tenant_URL> pela URL do seu locatário do Office 365):

   https://<office_365_tenant_URL>/_layouts/15/appregnew.aspx

3. Uma vez que você estiver na URL acima, será apresentada esta interface:

   

   • Client Id: Clique em Gerar para gerar um ID de cliente para seu aplicativo.

   • Client Secret: Clique em Gerar para gerar um segredo de cliente para seu aplicativo.

   • Título: Insira um título para seu aplicativo.

   • Domínio do Aplicativo: Insira um domínio para seu aplicativo ou insira um valor de espaço reservado.

   • URI de Redirecionamento: Insira uma URI de redirecionamento para seu aplicativo ou insira um valor de espaço reservado.

   Nota

   O conector Microsoft SharePoint 365 não utiliza o Domínio do Aplicativo ou a URI de Redirecionamento configurados.

4. Uma vez que todos os campos estejam preenchidos, clique em Criar. Uma página exibirá as informações do aplicativo. Mantenha essas informações para uso ao definir permissões para o aplicativo.

Definir permissões

Estas são as instruções para autorizar o aplicativo para uso com o conector Microsoft SharePoint 365:

1. Navegue até esta URL (substituindo <office_365_tenant_URL> pela URL do seu locatário do Office 365):

   https://<office_365_tenant_URL>/_layouts/appinv.aspx

2. Uma vez que você estiver na URL acima, será apresentada esta interface:

   

   • App Id: Insira o ID do cliente para o aplicativo (gerado durante a criação do aplicativo).

   • Título: Insira o título do seu aplicativo (definido durante a criação do aplicativo).

   • Domínio do Aplicativo: Insira o domínio do seu aplicativo (definido durante a criação do aplicativo).

   • URL de Redirecionamento: Insira a URL de redirecionamento para seu aplicativo (definida durante a criação do aplicativo).

   • XML de Solicitação de Permissão: Insira esta permissão na caixa de texto:

     <AppPermissionRequests AllowAppOnlyPolicy="true">
         <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />
     </AppPermissionRequests>
     

Para mais informações sobre permissões de complementos, consulte a documentação da Microsoft sobre Permissões de complementos no SharePoint e Fluxo de código de autorização OAuth para complementos do SharePoint.