Configuração do Confluence Cloud

Esta página descreve como configurar sua instância do Confluence Cloud antes de criar o repositório de dados do Confluence Cloud.

Configurar autenticação e permissões

Você precisa configurar a autenticação e as permissões na central de contas de administrador da Atlassian. Isso é fundamental para permitir que o conector acesse e sincronize dados. O conector do Confluence Cloud é compatível com vários métodos de autenticação, como credenciais do cliente OAuth ou tokens de API.

Criar um app OAuth 2.0

Para criar um app OAuth 2.0 para autenticação, siga estas etapas para configurar o aplicativo no Atlassian Play Console e receber o ID do cliente e a chave secreta do cliente necessários.

Verificar o acesso de administrador da organização do Confluence

Para verificar o acesso de administrador da organização do Confluence, faça o seguinte:

  1. Faça login no Atlassian com suas credenciais de usuário.

  2. Selecione o app Confluence.

  3. Clique em Configurações.

    Se a opção Sistema aparecer em Configurações do Confluence, você tem acesso de administrador da organização do Confluence. Caso contrário, peça ao administrador da organização do Confluence para conceder acesso.

Criar um app OAuth 2.0

Para criar um app OAuth 2.0, faça o seguinte:

  1. Faça login no Atlassian Developer Console.

  2. Clique no ícone de perfil e selecione Developer Console.

  3. Na página Console, clique em Criar e selecione Integração do OAuth 2.0.

  4. Na página de criação do app, faça o seguinte:

    1. Insira um nome para o app.

    2. Marque a caixa de seleção para concordar com os termos para desenvolvedores da Atlassian.

    3. Clique em Criar.

  5. Na página do app, faça o seguinte:

    1. No menu de navegação, clique em Autorização.

    2. Na tabela Tipo de autorização, selecione Adicionar para OAuth 2.0 (3LO).

  6. No campo URL de callback, insira https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html.

  7. Clique em Salvar alterações.

Obter o ID do cliente e a chave secreta do cliente

Para conseguir o ID e a chave secreta do cliente, faça o seguinte:

  1. Na página do app, clique em Distribuição no menu de navegação.

  2. Na página Distribuição, faça o seguinte:

    1. Na seção Controles de distribuição, selecione Editar.
    2. Na seção Status de distribuição, selecione Compartilhamento para ativar a edição de outros campos.
    3. Insira informações nos seguintes campos obrigatórios:
      1. Em Fornecedor, insira Google.
      2. Em Política de Privacidade, insira https://policies.google.com.
      3. Em O app armazena dados pessoais?, selecione Sim.
      4. Marque a caixa de seleção Confirmo que implementei a API de relatórios de dados pessoais.
    4. Clique em Salvar alterações.

  3. Na página do app, faça o seguinte:

    1. No menu de navegação, clique em Configurações.
    2. Na página de configurações, copie o ID do cliente e a chave secreta do cliente.

Receber um ID e um URL de instância

  1. Consiga o ID da instância:

    1. Abra uma nova guia, copie o URL da instância e adicione /_edge/tenant_info a ele. Por exemplo, https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info.
    2. Navegue até o link para encontrar o valor cloudId. O cloudId é o ID da instância.

  2. Consiga o URL da instância:

    1. Acesse atlassian.net e faça login com sua conta de administrador.
    2. Selecione o app que você quer sincronizar. Por exemplo, sincronize o primeiro app.
    3. Encontre o URL da instância (o subdomínio na barra de endereço).

Conceder papéis de administrador

Para conceder ao administrador do Confluence o papel de editor do Discovery Engine no console Google Cloud , faça o seguinte:

  1. No console Google Cloud , acesse a página Gemini Enterprise.

  2. Acesse IAM.

    Acessar IAM

  3. Localize a conta de usuário com acesso de administrador no Confluence e clique no ícone Editar .

  4. Conceda o papel de editor do Discovery Engine ao administrador.

Para conceder a um usuário uma função de administrador no Atlassian, faça o seguinte:

  1. Faça login no Atlassian usando uma conta de administrador da organização.

  2. Clique no ícone de menu e selecione sua organização. Ou acesse admin.atlassian.com.

  3. Na página Administrador, clique no produto e selecione o botão Gerenciar usuários.

  4. Clique em Grupos em Gerenciamento de usuários.

  5. Na página Grupos:

    1. Clique em Criar grupo.
    2. Digite um nome para o grupo.

Esse grupo recebe as permissões necessárias para o conector. Os usuários adicionados a esse grupo herdam essas permissões. O conector usa esse grupo para autenticar e buscar documentos.

  1. Na página do grupo, clique em Adicionar produto.

  2. Selecione Administrador de acesso do usuário como a função do Confluence.

  3. Selecione Administrador do produto como a função para Administração do Confluence.

  4. Clique em Permitir acesso.

  5. Clique em Adicionar membros do grupo para adicionar uma conta de usuário ou membros do grupo que o conector usa para autenticar e acessar os recursos necessários.

Configurar escopos mínimos do aplicativo

Para configurar o OAuth 2.0 e recuperar as credenciais necessárias para a configuração do conector do Confluence, faça o seguinte:

  1. Ative o OAuth 2.0:
    1. Clique em Permissões.
    2. Acesse a API Confluence.
    3. Clique em Adicionar.
    4. Clique em Configurar.
    5. Acesse a guia Escopos granulares e clique em Editar escopos.
    6. Selecione os seguintes escopos.
      • read:attachment:confluence
      • read:configuration:confluence
      • read:content.metadata:confluence
      • read:content-details:confluence
      • read:whiteboard:confluence
      • read:group:confluence
      • read:space:confluence
      • read:user:confluence
      • search:confluence
      • write:page:confluence
      • write:attachment:confluence
    7. Confirme se todos os escopos estão selecionados e salve as mudanças.

Configurar um token de API no Confluence

Se você planeja usar um token de API para autenticação, crie um token sem escopos. Esse conector não é compatível com tokens de API com escopos.

  1. Faça login no Atlassian Console.
  2. Clique em Criar um token de API.
  3. Insira um nome para o token de API.
  4. Selecione uma data de validade para o token de API. O período de expiração do token varia de 1 a 365 dias.
  5. Clique em Criar.
  6. Salve o token para uso posterior.

Gerenciar a visibilidade do usuário

Para tornar o e-mail do usuário visível para qualquer pessoa na conta da Atlassian, siga estas etapas:

  1. Faça login no Atlassian Developer Console.

  2. Clique no ícone de perfil e selecione Developer Console.

  3. Clique no ícone de perfil de usuário e selecione Gerenciar conta.

  4. Acesse Perfil e visibilidade.

  5. Acesse Contato e defina Quem pode ver isso como Qualquer pessoa.

Para tornar o e-mail do usuário visível para qualquer pessoa no Confluence, siga estas etapas:

  1. Faça login no Atlassian com suas credenciais de usuário.

  2. Selecione um app do Confluence.

  3. Clique em Configurações > Sistema.

  4. Selecione Configuração geral no painel à esquerda.

  5. Clique em Edit Settings.

  6. Em Visibilidade do e-mail do usuário, selecione Público.

  7. Clique em Atualizar.

Instalar e configurar o User Identity Accessor para o Confluence Cloud

Se os endereços de e-mail dos usuários não estiverem acessíveis publicamente por padrão devido às configurações de privacidade no Confluence Cloud, instale o app User Identity Accessor para Confluence Cloud para recuperar os endereços de e-mail dos usuários com segurança. Se os endereços de e-mail dos usuários já estiverem visíveis publicamente, talvez não seja necessário instalar o app. Para mais informações sobre a visibilidade restrita de e-mails, consulte Gerenciar a visibilidade do usuário e conceder papéis.

Papéis e permissões

Para instalar e configurar o app User Identity Accessor para Confluence Cloud, você precisa ter a função administrativa adequada e conceder as permissões necessárias no nível do app.

  • Função necessária: você precisa ser um Confluence Site administrator para instalar e configurar o app.
  • Permissões no app: você precisa conceder as seguintes permissões durante a instalação do app:
    • Read Email Address: permite que o app recupere com segurança endereços de e-mail do usuário, mesmo quando a visibilidade do perfil é restrita.
    • App Storage scope: permite que o app leia e grave no dispositivo de armazenamento.

Instalar o User Identity Accessor para Confluence Cloud

Para instalar o app User Identity Accessor para Confluence Cloud no seu site do Confluence, siga estas etapas:

  1. Acesse o Atlassian Developer Console.

  2. Revise as permissões Ler endereço de e-mail e Escopo de armazenamento do app e clique em Fazer o download app.

  3. Na lista Selecione um site para instalar este app, escolha o site do Confluence em que você quer instalar o app. Essa lista mostra apenas os sites em que você tem acesso de administrador.

    Observação: é necessário ser administrador de pelo menos um site do Confluence para instalar o app.

  4. Clique em Instalar para concluir a instalação do app.

Configurar o User Identity Accessor para o Confluence Cloud

Depois de instalar o app User Identity Accessor para Confluence Cloud, configure uma chave de API que seu sistema externo (por exemplo, o Conector do Confluence Cloud) usa para chamar com segurança o webtrigger do app e buscar e-mails.

Acessar a página de configuração

Para acessar a página de configuração do app User Identity Accessor para Confluence Cloud no Confluence Cloud, siga estas etapas:

  1. Na sua instância do Confluence Cloud, clique no ícone Configurações ⚙️ no menu de navegação.
  2. Selecione Apps no menu.
  3. Na página Administração de apps, localize o app Acessador de identidade do usuário para o Confluence Cloud na lista Gerenciar apps.
  4. Clique em Configurar ou no link associado ao app. A página de configuração dedicada do app será aberta no Confluence.

Configurar a chave de API

Para configurar a chave de API na página de configuração, siga estas etapas:

  1. Na seção Configuração da chave de API, especifique a chave secreta para autenticar solicitações ao webtrigger do app. É possível autenticar solicitações usando qualquer um dos seguintes métodos:

    • Inserir sua própria chave: digite ou cole sua própria chave de API forte e exclusiva no campo "Chave de API". Use uma chave de pelo menos 20 a 30 caracteres com uma combinação de letras maiúsculas, minúsculas, números e símbolos.

    • Gerar uma chave: clique no botão Gerar nova chave. O sistema gera e mostra uma chave forte e aleatória no campo.

      Importante: copie imediatamente a chave de API exibida no campo. Por motivos de segurança, talvez não seja possível ver a chave completa novamente depois de salvar ou sair da página. Se você perder a senha, será necessário definir ou gerar uma nova.

  2. Clique em Salvar chave de API. Uma mensagem de confirmação vai aparecer informando que a chave foi salva com segurança.

Testar a configuração do app

Verifique se o app User Identity Accessor para Confluence Cloud está configurado corretamente enviando uma solicitação do seu sistema externo e confirmando que os endereços de e-mail do usuário são retornados corretamente.

Acessar o URL do webtrigger
  1. Na página Administração de apps, localize a seção URL do Webtrigger, que mostra o URL exclusivo específico do seu site do Confluence e desta instalação do app:
    • Seu sistema externo precisa chamar esse URL para solicitar e-mails de usuários. Por exemplo, https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, em que YOUR_INSTANCE_ID é o identificador da instância do Confluence Cloud e WEBTRIGGER_ID é o identificador exclusivo do endpoint webtrigger gerado para seu app.
  2. Clique no botão Copiar URL ou copie o URL inteiro.
Configurar o sistema externo

  • Configure seu sistema externo que precisa buscar e-mails de usuários do Confluence com a chave de API e o URL do webtrigger obtidos nas etapas anteriores.

    • URL do endpoint: o URL do webtrigger que você copiou.
    • Método HTTP: POST

    • Cabeçalhos obrigatórios:

      • Content-Type: application/json

      • X-Api-Key: YOUR_API_KEY

        Substitua YOUR_API_KEY pela chave de API que você definiu ou gerou na seção Configurar a chave de API.

Exemplo de comando curl

Este exemplo demonstra a chamada do webtrigger User Identity Accessor for Confluence Cloud, que aceita uma matriz de IDs de conta e retorna os endereços de e-mail.

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

Substitua:

  • YOUR_INSTANCE_ID pelo ID da instância do Confluence Cloud
  • ENDPOINT_PATH com o caminho do endpoint de API
  • YOUR_API_KEY com a chave de API que você definiu ou gerou na seção Configurar a chave de API
  • ACCOUNT_ID com os IDs das contas da Atlassian que você quer segmentar
Resposta esperada
[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

Substitua:

  • ACCOUNT_ID_X com IDs de contas da Atlassian reais
  • USER_EMAIL_X com endereços de e-mail de usuários retornados da chamada de API

Implementar práticas recomendadas de segurança

Para confirmar a segurança da sua chave de API, siga estas recomendações:

  • Armazene a chave de API com segurança na configuração do Conector do Confluence Cloud.
  • Verifique se toda a comunicação com o URL do webhook ocorre por HTTPS. Esse é o padrão para gatilhos da Web do User Identity Accessor for Confluence Cloud.

Suporte para o User Identity Accessor no Confluence Cloud

As ofertas de suporte estão disponíveis em Google para o app User Identity Accessor para Confluence Cloud, que pode incluir manutenção e atualizações regulares para manter o app atualizado. Se você tiver problemas ou dúvidas específicas sobre a funcionalidade do app, entre em contato com o suporte doGoogle Cloud .