使用 REST API 定制 Oracle Universal Authenticator 客户端应用程序

简介

本教程演示如何使用 REST API 和 Postman 定制 Oracle Universal Authenticator 客户端应用程序。

先决条件

开始本教程之前，您必须具有：

阅读并理解 Customizing the Oracle Universal Authenticator Client Application 。
使用 Oracle Universal Authenticator 部署的正在运行的 Oracle Advanced Authentication 安装。
根据安装 Oracle Universal Authenticator 客户机应用程序，在设备上安装 Oracle Universal Authenticator 客户机应用程序。
熟悉 REST 体系结构样式。
已安装 Native Postman client 应用程序。
已下载 json 文件 Oracle_Universal_Authenticator_REST_API.postman_collection.json 、Oracle_Universal_Authenticator_Example_Environment.postman_environment.json 。

注意：使用 REST API 更新属性时，管理员应注意以下事项：

将覆盖以前根据 Customizing During Installation 在安装期间定制的任何属性。如果您希望保留其中一些定制属性，则必须使用本教程中概述的 REST API 在主题中再次添加所有这些属性。
默认情况下不存在主题。即使您在安装期间根据 Customizing During Installation 对属性进行了定制，也是如此。
主题必须使用 REST API 根据需要按区域设置创建。
要激活主题，必须将 oua.themes.custom.distribution 设置为 1，如本教程后面所示。
激活主题后，设备会定期与 OAA 服务器联系以获取任何更新，并在收到通知后使用主题。这将覆盖在安装期间定制的所有安装。
下次 OUA 客户机应用程序与 OAA 服务器联系时，对这些主题的任何后续更新都将传送到设备。

安装 Oracle Advanced Authentication Postman 集合

在 Postman 中设置环境参数

注意：下面的步骤可能因您的 Postman 版本而异。

打开 Postman，然后在工作区中选择环境。
单击导入。
在 Import（导入）对话框中，选择或删除 Oracle_Universal_Authenticator_Example_Environment.postman_environment.json ，然后单击 Open（打开）。
在显示的环境列表中，单击 Oracle Universal Authenticator 示例环境右侧的省略号，然后单击复制。
在原始环境上方显示的 Oracle Universal Authenticator 示例环境复制上，单击省略号并重命名为 Oracle Universal Authenticator Environment for REST APIs。
通过为初始值和当前值输入以下值来更新新环境的环境变量。完成后，单击保存：
- RELEASENAME ：分配给 Oracle Advanced Authentication 设置的 RELEASENAME，例如 oaainstall。
- DRSS_URL ：Oracle Advanced Authentication 中 DRSS 端点的 URL，例如 https://oaa.example.com/oaa-drss。
- DRSS_USERNAME ：DRSS API 的用户名，格式为 RELEASENAME-oaa-drss，例如 oaainstall-oaa-drss。
- DRSS_PASSWORD ：Oracle Advanced Authentication 设置的 drssapikey。
注意：如果您不知道 RELEASENAME、DRSS_URL、DRSS_USERNAME 和 DRSS_PASSWORD，请参阅打印部署详细信息。

环境将类似于以下内容：
单击环境下拉列表，然后从列表中选择更新的环境：

导入 Postman 集合

要导入 Oracle Advanced Authentication REST API Postman 集合，请选择集合 > 导入。
在导入对话框中，选择或删除 Oracle_Universal_Authenticator_REST_API.postman_collection.json 。

集合应显示如下：

测试主题 API

创建语言主题

注：要防止 SSL 证书验证错误，请在导航汉堡程序菜单中导航到文件 > 设置，然后在“一般信息”选项卡中关闭 SSL 证书验证。

在此部分中，您将为要自定义的项创建语言主题。

在“集合”选项卡中，导航到 Oracle Universal Authenticator REST API > 主题管理 API 。
选择 PUT updateLocale 。此请求向 oaa-drss/v1/themes/<locale> 端点发出 PUT 请求，并根据正文中的信息为所需的区域设置创建主题。

根据需要更改或删除字段和值。

在此示例中，创建了 en_US 语言的主题 oaa-drss/v1/themes/en_US，并更新了所有可定制的属性。

对于标识值，必须使用您选择的实用程序将 bmp 文件转换为 BASE64，然后将该值粘贴到 logo 条目中。
单击发送。
在响应中，确认显示 204 No Content。
为所需的其他语言创建更多主题。在此示例中，创建了法语 fr 语言的主题 oaa-drss/v1/themes/fr，并更新了所有可定制属性。

注：自定义的所有文本都必须使用所创建主题的语言。
单击发送。
在响应中，确认显示 204 No Content。
对所需的任何其他语言主题重复上述内容，例如西班牙语等。

获取语言主题

在“集合”选项卡中，导航到 Oracle Universal Authenticator REST API > 主题管理 API
选择 GET getLocale 。此请求向 oaa-drss/v1/themes/locales 端点发出 GET 请求，并返回创建的所有主题。
单击发送。
在响应中，确认显示 Status: 200 OK。将返回主题列表。

获取主题的定制属性

在“集合”选项卡中，导航到 Oracle Universal Authenticator REST API > 主题管理 API 。
选择 GET getLocale 。此请求向 oaa-drss/v1/themes/<locale> 端点发出 GET 请求，并返回主题的所有定制属性。
单击发送。
在响应中，确认显示 Status: 200 OK。将返回定制的属性列表。

注意：除了已定制的参数，您还将看到未定制的参数的默认值，以及不可定制的其他参数。

激活主题

要开始使用 Oracle Universal Authenticator 客户机应用程序中的主题，必须将 oua.themes.custom.distribution 属性设置为 "1"。

在“集合”选项卡中，导航到 Oracle Universal Authenticator REST API > 主题管理 API 。
选择 PUT oua.themes.custom.distribution 。此请求通过在正文中设置 oua.themes.custom.distribution 属性向 oaa-drss/oua/property/v1 端点发出 PUT 请求。值 1 将激活主题，值 0 将停用主题。默认值为 0。
单击发送。
在响应中，确认显示 Status: 200 OK，并且响应包含设置为 1 的 oua.themes.custom.distribution。

更新主题

在“集合”选项卡中，导航到 Oracle Universal Authenticator REST API > 主题管理 API 。
选择 PUT updateLocale 。此请求向 oaa-drss/v1/themes/<locale> 端点发出 PUT 请求，并根据正文中的信息为所需的区域设置创建或更新主题。

根据需要更新或删除字段和值。

注意：以及要更新的字段，必须包括以前定制的所有字段。如果不添加以前定制的属性，将使用默认值覆盖这些属性。

在此示例中，CPFT_TILE_IMAGE 更新为 Enter your Example Company Username"。
单击发送。
在响应中，确认显示 204 No Content。

删除主题

删除主题将完全删除主题。管理员在删除主题时应小心谨慎，并注意以下事项：

如果删除主题，则 Oracle Universal Client Authenticator 客户端应用程序将继续使用它在删除主题之前使用的主题。
如果要将 Oracle Universal Client Authenticator 客户机应用程序恢复为现成的默认值，则可以执行以下操作之一：
- 删除主题，然后使用虚拟值再次创建主题。
- 不要删除主题，而应使用 "status": 0 更新主题。

在“集合”选项卡中，导航到 Oracle Universal Authenticator REST API > 主题管理 API 。
选择 DEL deleteLocale 。此请求向 oaa-drss/v1/themes/<locale> 端点发出 DELETE 请求，并删除指定区域设置的主题。

在此示例中，删除了西班牙语言环境 (es)。
单击发送。
在响应中，确认显示 204 No Content。
如果需要使用虚拟值更新主题，请使用 PUT updateLocale 更新主题，然后单击发送。此时将显示一条 204 No Content 消息：

了解更多

Oracle Universal Authenticator

反馈

要提供有关本教程的反馈，请联系 idm_user_assistance_ww_grp@oracle.com

致谢

作者 - Russ Hodgson