API凭据和产品配置文件管理
了解如何为基于OpenAPI的AEM API管理 凭据和产品配置文件。
在本教程中,您将学习如何添加或删除:
- 凭据:为AEM API提供身份验证。
- 产品配置文件:为访问AEM资源的凭据提供权限(或授权)。
背景
使用AEM API时,您需要在Adobe Developer Console (或ADC)项目中定义 凭据 和 产品配置文件。 在以下屏幕截图中,您可以看到AEM Assets创作API的 凭据 和 产品配置文件:
凭据 提供API的身份验证机制。 产品配置文件 向凭据授予 权限(或授权),以提供对AEM资源的访问权限。 API请求可以代表应用程序或用户。
产品配置文件与一个或多个 服务 关联。 在AEM as a Cloud Service中,服务 表示具有预定义的存储库节点访问控制列表(ACL)的用户组,允许精细的权限管理。
成功调用API后,将在AEM创作服务中创建表示ADC项目凭据的用户,以及匹配产品配置文件和服务配置的用户组。
在上述方案中,用户1323d2...
是在AEM Author服务中创建的,并且是用户组AEM Assets Collaborator Users - Service
和AEM Assets Collaborator Users - author - Program XXX - Environment XXX
的成员。
添加或删除凭据
AEM API支持以下类型的身份验证凭据:
- OAuth服务器到服务器:专为计算机到计算机交互而设计。
- OAuth Web应用程序:专为与客户端应用程序中的后端服务器进行用户驱动的交互而设计。
- OAuth单页应用程序:专为客户端应用程序中无后端服务器的用户驱动交互而设计。
您可以使用不同类型的凭据支持各种用例。
所有凭据都在您的ADC项目中管理。
若要为AEM API添加凭据,请转到ADC项目的 API 部分,然后单击 连接其他凭据。 然后,按照特定凭据类型的说明进行操作。
要删除AEM API凭据,请在ADC项目的 API 部分中选择它,然后单击 删除凭据。
添加或删除产品配置文件
产品配置文件 为访问AEM资源的凭据提供 权限(或授权)。 产品配置文件 提供的权限基于与 产品配置文件 关联的 服务。 大多数 服务 通过与 服务 同名的AEM实例中的用户组,为AEM资源提供 读取 权限。
有时,凭据(又称技术帐户用户)需要其他权限,如AEM资源的 创建、更新、删除 (CUD)。 在这种情况下,您需要添加与 服务 关联的新 产品配置文件,以提供所需的权限。
例如,当AEM Assets Author API调用收到非GET请求的403错误时,您可以添加 AEM Administrators - author - Program XXX - Environment XXX 产品配置文件 来解决此问题。
要为AEM API添加产品配置文件,请在ADC项目的 API 部分中单击 编辑产品配置文件,在 配置API 对话框中选择所需的产品配置文件,并保存更改。
选择与所需服务关联的所需产品配置文件(例如 AEM Administrators - author - Program XXX - Environment XXX),然后保存更改。
请注意,AEM Administrators - author - Program XXX - Environment XXX 产品配置文件与 AEM Administrators 服务和 AEM Assets API Users 服务相关联。 如果没有后者,产品配置文件将不会显示在可用产品配置文件列表中。
用于更新资源元数据的 PATCH 请求现在应可正常使用,而不会出现问题。
要删除AEM API的产品配置文件,请在ADC项目的 API 部分中单击 编辑产品配置文件,在 配置API 对话框中取消选择所需的产品配置文件,并保存更改。
摘要
您已了解如何使用Adobe Developer Console (ADC)项目中的 凭据和产品配置文件 更改AEM API的身份验证机制和权限。