

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á.

# Document-level controles de acesso
<a name="confluence-kb-acl"></a>

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
<a name="confluence-kb-acl-how-it-works"></a>

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. **Pre-retrieval filtragem** — 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.

1. **Real-time verificação** — 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
<a name="confluence-kb-acl-enable"></a>

Você configura o gerenciamento de ACL durante a criação da base de conhecimento na etapa **Configurações adicionais**. Marque a caixa de seleção **Controlar acesso a documentos com ACLs** 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](#confluence-kb-atlassian-admin-credentials) Para obter as etapas de configuração da base de conhecimento, consulte[Autentique sua conta](confluence-knowledge-base.md#confluence-kb-setup-auth).

Para obter mais informações sobre as melhores práticas de ACL, consulte[Melhores práticas para gerenciar ACLs em bases de conhecimento](acl-best-practices-kb.md).

## Real-time verificação de acesso
<a name="confluence-kb-acl-realtime"></a>

Quando um usuário envia uma consulta que envolve conteúdo de uma base de conhecimento do ACL-enabled Confluence, 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.

1. Se a resposta envolver conteúdo do Confluence de uma base de ACL-enabled conhecimento, o Quick solicita que o usuário faça login no Confluence.

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

1. 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.

1. 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
<a name="confluence-kb-atlassian-admin-credentials"></a>

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
<a name="confluence-kb-admin-api-key"></a>

1. Faça login no [portal de administração da Atlassian](https://admin.atlassian.com/) com permissões de administrador.

1. 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`.

1. Copie o **ID da organização** do URL.

1. Selecione **Configurações** e escolha **Chaves de API**.

1. Escolha **Criar chave de API**.

1. Selecione os seguintes escopos para a chave de API:
   + `read:directories:admin`
   + `read:workspaces:admin`

1. 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
<a name="confluence-kb-admin-directory-id"></a>

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.

1. 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.

1. 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](https://developer.atlassian.com/cloud/admin/scopes/). Para obter detalhes da API, consulte a [referência de API espaço de trabalho de administração da Atlassian](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-group-workspaces).

## Limitações
<a name="confluence-kb-acl-limitations"></a>
+ São **necessárias as credenciais de administrador da Atlassian** — os controles de Document-level acesso exigem as 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.
+ Real-time a **verificação é obrigatória** — o Amazon Quick sempre realiza verificações de permissão em tempo real no momento da consulta para bases de ACL-enabled conhecimento. Se a API do Confluence não estiver disponível, as consultas que envolvem ACL-protected conteúdo retornam 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 gerenciar ACLs em bases de conhecimento](acl-best-practices-kb.md)

## Próximas etapas
<a name="confluence-kb-acl-next-steps"></a>

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)](sync-reports-observability.md#sync-reports-acl-verification) 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](confluence-knowledge-base.md#confluence-kb-setup)