Customizing After Installation
To customize the Oracle Universal Authenticator client application at any time after installation, you can use REST APIs.
Before performing customization, administrators should be aware of the following:
- You can customize any combination of properties you require from Customizable Items.
- It not customized, all the default values for fields, labels, text, and error messages, will be displayed in the language used by the Microsoft Windows desktop. If you choose to customize, you can create any number of themes for different languages, but the values for the properties you customize must be written in the language required, as customized text will not be translated automatically. For information on languages supported, see Customizable Items.
- If customizing the logo, it must be bitmap format only (BMP), and have dimensions of 192x192. No other formats or dimensions are supported. Before using the BMP file it is advisable to open it in Microsoft Paint and save the file so it is in the correct format.
- If you customized the client application during installation as per Customizing During Installation, you can use the REST APIs to make changes post installation.
The OAA-Device Runtime Support Service REST API allows
the following operations on the
<DRSS>/v1/themes/{locale} endpoint:
PUT: Create or update a theme with customized properties for a specific language.GET: Retrieve the themes created, or retrieve customized properties for a specific language theme.DELETE: Delete a theme for a specific language.
For themes to be used by the Oracle Universal Authenticator client application, you must
activate them. This is performed by setting the
oua.themes.custom.distribution property to 1, using
the <DRSS>/oaa-drss/oua/property/v1 endpoint. You can deactivate themes
at any time, by setting this property to 0. Administrators should however
be aware of the following:
- The default value for
oua.themes.custom.distributionis0. This means no themes are distributed by default. - When
oua.themes.custom.distributionis1, themes will be distributed to the Oracle Universal Authenticator client application when the client application checks for update with the server. - If
oua.themes.custom.distributionis changed from1to0, the Oracle Universal Authenticator client application will continue to use the theme last distributed. It will not revert to the out of the box default values. - If a theme is deleted, and
oua.themes.custom.distributionis1, then the Oracle Universal Authenticator client application will continue to use the theme it was using before the theme was deleted. If you want the Oracle Universal Authenticator client application to revert to the out of the box default values, you must update the deleted theme with a dummy value. - If a theme is updated with
"status": 0andoua.themes.custom.distributionis1, then the Oracle Universal Authenticator client application will revert to the out of the box default values.
For more information on the REST APIs used for customization, see OAA-Device Runtime Support Service REST API.
The following tutorial shows detailed information on using the OAA-Device Runtime Support
Service REST API to customize the Oracle Universal Authenticator client application: