Credenciais da API e gerenciamento do Perfil do produto
Saiba como gerenciar Credenciais e Perfil de Produto para APIs do AEM baseadas em OpenAPI.
Neste tutorial, você aprenderá a adicionar ou remover:
- Credenciais: forneça autenticação para uma API do AEM.
- Perfis de produto: forneça permissões (ou autorização) para as credenciais acessarem os recursos do AEM.
Fundo
Ao usar uma API do AEM, você precisa definir as Credenciais e o Perfil do Produto no projeto do Adobe Developer Console (ou ADC). Na captura de tela a seguir, você pode ver as Credenciais e o Perfil do Produto para uma API de Autor do AEM Assets:
As Credenciais fornecem o mecanismo de autenticação para a API. O Perfil de Produto concede permissões (ou autorização) às credenciais, fornecendo acesso aos recursos do AEM. A solicitação da API pode ser feita em nome de um aplicativo ou usuário.
Um Perfil de Produto está associado a um ou mais Serviços. No AEM as a Cloud Service, um Serviço representa grupos de usuários com ACLs (Listas de Controle de Acesso) predefinidas para nós de repositório, permitindo o gerenciamento granular de permissões.
Após a invocação bem-sucedida da API, um usuário que representa a credencial do projeto ADC é criado no serviço do Autor do AEM, juntamente com os grupos de usuários que correspondem à configuração do Perfil de produto e dos Serviços.
No cenário acima, o usuário 1323d2... é criado no serviço de Autor do AEM e é membro dos grupos de usuários AEM Assets Collaborator Users - Service e AEM Assets Collaborator Users - author - Program XXX - Environment XXX.
Adicionar ou remover credenciais
As APIs do AEM são compatíveis com os seguintes tipos de credenciais para autenticação:
- OAuth Server-to-Server: projetado para interações máquina a máquina.
- Aplicativo Web OAuth: projetado para interações orientadas pelo usuário com um servidor back-end em seu aplicativo cliente.
- Aplicativo de Página Única do OAuth: projetado para interações orientadas pelo usuário sem um servidor back-end no aplicativo cliente.
Você pode dar suporte a vários casos de uso usando diferentes tipos de credenciais.
Todas as credenciais são gerenciadas no projeto ADC.
Para adicionar credenciais para uma API do AEM, vá para a seção APIs do projeto ADC e clique em Conectar outra credencial. Em seguida, siga as instruções para o tipo de credencial específico.
Para remover uma credencial de API do AEM, selecione-a na seção APIs do projeto ADC e clique em Excluir credencial.
Adicionar ou remover perfis de produto
O Perfil de Produto fornece as permissões (ou autorização) às credenciais para acessar os recursos do AEM. As permissões fornecidas pelo Perfil de Produto são baseadas nos Serviços associados ao Perfil de Produto. A maioria dos Serviços fornece a permissão LER para os recursos do AEM, por meio dos grupos de usuários na instância do AEM que têm o mesmo nome que o Serviço.
Às vezes, as credenciais (também conhecidas como usuário de conta técnica) precisam de permissões adicionais, como Criar, Atualizar, Excluir (CUD) dos recursos do AEM. Nesses casos, você precisa adicionar um novo Perfil de Produto que esteja associado aos Serviços que fornecem as permissões necessárias.
Por exemplo, quando a invocação da API do autor do AEM Assets recebe o erro 403 para solicitações que não sejam da GET, você pode adicionar Administradores do AEM - autor - Programa XXX - Ambiente XXX Perfil do produto para resolver o problema.
Para adicionar Perfis de produto para uma API do AEM, clique em Editar perfis de produto na seção APIs do projeto ADC, selecione o Perfil de Produto desejado na caixa de diálogo Configurar API e salve as alterações.
Selecione o Perfil de Produto desejado (por exemplo, Administradores do AEM - autor - Programa XXX - Ambiente XXX) associado aos serviços necessários e salve as alterações.
Observe que o Perfil de Produto de Administradores do AEM - Autor - Programa XXX - Ambiente XXX está associado ao serviço de Administradores do AEM e ao serviço de Usuários da API AEM Assets. Sem esse último, o Perfil do produto não aparecerá na lista de Perfis de produto disponíveis.
A solicitação PATCH para atualizar os metadados do ativo agora deve funcionar sem problemas.
Para remover Perfis de Produto de uma API do AEM, clique em Editar perfis de produto na seção APIs do projeto ADC, desmarque o Perfil de Produto desejado na caixa de diálogo Configurar API e salve as alterações.
Resumo
Você aprendeu a alterar o mecanismo de autenticação e as permissões das APIs do AEM usando as Credenciais e o Perfil do Produto no projeto do Adobe Developer Console (ADC).