View a markdown version of this page

Controles de acesso em nível de documento - Amazon Quick
Como funcionaAtivar o gerenciamento de ACLVerificação de acesso em tempo realObtenha as credenciais de administrador da AtlassianLimitaçõesPróximas etapas

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Controles de acesso em nível de documento

As bases de conhecimento do Confluence Cloud oferecem suporte opcional ao controle de acesso em nível de documento. Quando ativado, o Amazon Quick sincroniza as listas de controle de acesso (ACLs) do Confluence durante cada rastreamento e verifica as permissões de cada usuário no momento da consulta. Os usuários só veem respostas de documentos que estão autorizados a acessar no Confluence.

Como funciona

Quando um usuário consulta um agente do Amazon Quick que usa uma base de conhecimento do Confluence com o gerenciamento de ACL ativado, o sistema aplica controles de acesso em dois estágios:

  1. Filtragem de pré-recuperação — O Amazon Quick realiza uma pesquisa semântica no índice vetorial para encontrar as passagens mais relevantes do documento. O sistema aplica listas de controle de acesso que foram sincronizadas do Confluence durante o último rastreamento. Isso produz um conjunto preliminar de documentos candidatos.

  2. Verificação em tempo real — O sistema verifica os documentos candidatos em tempo real, verificando o acesso atual do usuário consultor no Confluence. Somente os documentos que o usuário está atualmente autorizado a acessar aparecem na resposta.

Essa abordagem de dois estágios fornece controle de acesso em nível de documento que permanece atualizado mesmo quando as permissões do Confluence mudam entre as sincronizações.

O Amazon Quick rastreia os seguintes recursos do Confluence ACL:

  • Espaços — As permissões de espaço se aplicam a todos os documentos no espaço por padrão.

  • Páginas — As páginas podem ser restritas a usuários e grupos específicos. As páginas aninhadas herdam as restrições da página principal e podem ter suas próprias restrições.

  • Blogs — As postagens do blog podem ser restritas a usuários e grupos específicos no espaço.

  • Anexos — Os arquivos anexados às páginas ou publicações do blog herdam os controles de acesso do documento principal.

Ativar o gerenciamento de ACL

Você configura o gerenciamento de ACL durante a criação da base de conhecimento na etapa Configurações adicionais. Marque a ACLs caixa de seleção Controlar acesso ao documento com para ativá-la. Essa opção requer credenciais de administrador da Atlassian, que você fornece durante a etapa do método de autenticação. Sem credenciais de administrador, a opção ACL está desativada.

Importante

Você não pode alterar o gerenciamento da ACL depois de criar a base de conhecimento. Se precisar alterar essa configuração, você deverá criar uma nova base de conhecimento.

As credenciais de administrador da Atlassian permitem que o Amazon Quick acesse todas as informações de usuários e grupos da sua instância do Confluence, independentemente das configurações individuais de visibilidade de e-mail. Para ver as etapas para obter credenciais de administrador da sua organização Atlassian, consulte. Obtenha as credenciais de administrador da Atlassian Para obter as etapas de configuração da base de conhecimento, consulteAutentique sua conta.

Para obter mais informações sobre as melhores práticas de ACL, consulteMelhores práticas para gerenciamento ACLs em bases de conhecimento.

Verificação de acesso em tempo real

Quando um usuário envia uma consulta que envolve conteúdo de uma base de conhecimento do Confluence habilitada para ACL, o Amazon Quick verifica o acesso do usuário em tempo real:

  1. O usuário faz uma pergunta no assistente de bate-papo rápido.

  2. Se a resposta envolver conteúdo do Confluence de uma base de conhecimento habilitada para ACL, o Quick solicitará que o usuário entre no Confluence.

  3. O usuário faz login com seu e-mail e senha do Confluence e aceita a caixa de diálogo de autorização.

  4. O Quick usa as credenciais do usuário para verificar o acesso a cada documento candidato em tempo real com base na API do Confluence.

  5. Somente os documentos aos quais o usuário tem acesso atualmente no Confluence aparecem na resposta.

O login é uma etapa única. Depois de fazer login, os usuários não são avisados novamente até que a sessão expire.

nota

Se a verificação de permissão em tempo real falhar (por exemplo, se a API do Confluence estiver temporariamente indisponível), os usuários verão uma mensagem de erro solicitando que tentem novamente. O Amazon Quick não recorre às permissões em cache — a verificação em tempo real é obrigatória para garantir a precisão do controle de acesso.

Obtenha as credenciais de administrador da Atlassian

Para fornecer as credenciais de administrador da Atlassian durante a configuração da base de conhecimento do Confluence, o administrador da sua organização Atlassian deve concluir as etapas a seguir.

Obtenha sua chave de API e ID da organização

  1. Faça login no portal de administração da Atlassian com permissões de administrador.

  2. Abra a aplicação de administração da sua organização. O URL deve ser semelhante a:https://admin.atlassian.com/o/ORGANIZATION-UUID/overview.

  3. Copie o ID da organização do URL.

  4. Selecione Configurações e escolha Chaves de API.

  5. Escolha Criar chave de API.

  6. Selecione os seguintes escopos para a chave de API:

    • read:directories:admin

    • read:workspaces:admin

  7. Copie e salve o ID da organização e a chave de API.

    nota

    As chaves de API expiram. Monitore a data de expiração e atualize as credenciais da fonte de dados antes que a chave expire.

Obter o ID do diretório

Use a API Atlassian Admin Workspace para recuperar seu ID de diretório.

  1. Execute o comando a seguir, ORGANIZATION-ID substituindo-o pelo ID da organização e API-KEY pela chave de API:

    curl --request POST \
  --url 'https://api.atlassian.com/admin/v2/orgs/ORGANIZATION-ID/workspaces' \
  --header 'Authorization: Bearer API-KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": {
      "field": {
        "name": "attributes.type",
        "values": ["confluence"]
      }
    },
    "limit": 20
  }'

    Essa consulta filtra os resultados somente para espaços de trabalho do Confluence, então você não precisa percorrer todos os tipos de espaços de trabalho.

  2. Na resposta da API, encontre a entrada do espaço de trabalho que corresponde à sua instância do Confluence Cloud. Verifique se o nome do espaço de trabalho corresponde à sua instância.

  3. Copie o directory valor da attributes seção. Esse é o seu ID de diretório.

Para ter mais informações sobre os escopos de API de administração da Atlassian, consulte a documentação de escopos de API da Atlassian. Para obter detalhes da API, consulte a referência de API espaço de trabalho de administração da Atlassian.

Limitações

  • São necessárias credenciais de administrador da Atlassian — Os controles de acesso em nível de documento exigem credenciais de administrador da Atlassian, que devem ser fornecidas durante a configuração da base de conhecimento. Você não pode habilitar ACLs sem credenciais de administrador e não pode adicionar credenciais de administrador após a criação da base de conhecimento.

  • A verificação em tempo real é obrigatória — o Amazon Quick sempre realiza verificações de permissão em tempo real no momento da consulta para bases de conhecimento habilitadas para ACL. Se a API do Confluence não estiver disponível, as consultas que envolvam conteúdo protegido por ACL retornarão um erro em vez de retornarem às permissões em cache.

Para ver as limitações gerais e as melhores práticas da ACL, incluindo permanência da ACL, compatibilidade de pesquisa e gerenciamento de endereços de e-mail, consulte. Melhores práticas para gerenciamento ACLs em bases de conhecimento

Próximas etapas

Para verificar os controles de acesso em nível de documento e solucionar problemas de permissão, consulte. Verifique o acesso ao documento (verificação da ACL) Para obter informações sobre como configurar a integração da base de conhecimento do Confluence, consulte. Configurar a integração da base de conhecimento