Credenciales de API y administración de perfiles de producto
Obtenga información sobre cómo administrar credenciales y perfil de producto para las API de AEM basadas en OpenAPI.
En este tutorial, aprenderá a añadir o eliminar:
- Credenciales: proporcione autenticación para una API de AEM.
- Perfiles de producto: proporcione permisos (o autorización) para que las credenciales tengan acceso a los recursos de AEM.
Fondo
Cuando usa una API de AEM, necesita definir las credenciales y el perfil del producto en el proyecto de Adobe Developer Console (o ADC). En la siguiente captura de pantalla, puede ver las credenciales y el perfil de producto para una API de autor de AEM Assets:
Las credenciales proporcionan el mecanismo de autenticación para la API. El Perfil del producto concede permisos (o autorización) a las credenciales, lo que proporciona acceso a los recursos de AEM. La solicitud de API puede ser en nombre de una aplicación o de un usuario.
Un perfil de producto está asociado con uno o más servicios. En AEM as a Cloud Service, un servicio representa grupos de usuarios con Listas de control de acceso (ACL) predefinidas para los nodos del repositorio, lo que permite la administración granular de permisos.
Una vez invocada correctamente la API, se crea un usuario que representa las credenciales del proyecto ADC en el servicio de creación de AEM, junto con los grupos de usuarios que coinciden con la configuración del perfil de producto y los servicios.
En el escenario anterior, se crea el usuario 1323d2... en el servicio de creación de AEM y es miembro de los grupos de usuarios AEM Assets Collaborator Users - Service y AEM Assets Collaborator Users - author - Program XXX - Environment XXX.
Agregar o quitar credenciales
Las API de AEM admiten los siguientes tipos de credenciales para la autenticación:
- Servidor a servidor OAuth: diseñado para interacciones máquina a máquina.
- Aplicación web OAuth: diseñada para interacciones impulsadas por el usuario con un servidor back-end en la aplicación cliente.
- Aplicación de una sola página de OAuth: diseñada para interacciones impulsadas por el usuario sin un servidor back-end en la aplicación cliente.
Puede admitir varios casos de uso utilizando diferentes tipos de credenciales.
Todas las credenciales se administran en el proyecto ADC.
Para agregar credenciales para una API de AEM, vaya a la sección API de su proyecto de ADC y haga clic en Conectar otra credencial. A continuación, siga las instrucciones de su tipo de credencial específico.
Para quitar una credencial de la API de AEM, selecciónela en la sección API de su proyecto de ADC y luego haga clic en Eliminar credencial.
Añadir o quitar perfiles de producto
El perfil de producto proporciona los permisos (o autorización) a las credenciales para acceder a los recursos de AEM. Los permisos proporcionados por el Perfil del producto se basan en los servicios asociados con el Perfil del producto. La mayoría de los servicios proporcionan el permiso READ a los recursos de AEM a través de los grupos de usuarios en la instancia de AEM que tienen el mismo nombre que Servicio.
Hay ocasiones en que las credenciales (también conocido como usuario de cuenta técnica) necesitan permisos adicionales como Crear, Actualizar, Eliminar (CUD) de recursos de AEM. En estos casos, debe agregar un nuevo Perfil del producto que esté asociado con los servicios que proporcionan los permisos necesarios.
Por ejemplo, cuando la invocación de la API de autor de AEM Assets recibe un error 403 en solicitudes que no son de GET, puede agregar Administradores de AEM - autor - Programa XXX - Entorno XXX Perfil del producto para resolver el problema.
Para agregar perfiles de producto para una API de AEM, haga clic en Editar perfiles de producto en la sección API del proyecto ADC, seleccione el perfil de producto deseado en el cuadro de diálogo Configurar API y guarde los cambios.
Seleccione el perfil de producto deseado (por ejemplo, Administradores de AEM - autor - Programa XXX - Entorno XXX) asociado con los servicios requeridos y, a continuación, guarde los cambios.
Tenga en cuenta que el perfil de producto Administradores de AEM - autor - Programa XXX - Entorno XXX está asociado con el servicio Administradores de AEM y con el servicio Usuarios de API de AEM Assets. Sin esta última opción, el perfil de producto no aparecerá en la lista de perfiles de producto disponibles.
La solicitud de PATCH para actualizar los metadatos del recurso debería funcionar ahora sin problemas.
Para quitar los perfiles de producto de una API de AEM, haga clic en Editar perfiles de producto en la sección API del proyecto ADC, anule la selección del perfil de producto deseado en el cuadro de diálogo Configurar API y guarde los cambios.
Resumen
Ha aprendido a cambiar el mecanismo de autenticación y los permisos para las API de AEM usando Credenciales y Perfil del producto en el proyecto de Adobe Developer Console (ADC).