Personnalisation de l'application client Oracle Universal Authenticator à l'aide d'API REST

Introduction

Ce tutoriel explique comment personnaliser l'application client Oracle Universal Authenticator à l'aide des API REST et de Postman.

Prérequis

Avant de commencer ce tutoriel, vous devez disposer des éléments suivants :

Lisez et comprenez Personnalisation de l'application client Oracle Universal Authenticator.
Installation d'Oracle Advanced Authentication en cours d'exécution déployée avec Oracle Universal Authenticator.
Installation de l'application client Oracle Universal Authenticator sur les appareils conformément à la section Installation de l'application client Oracle Universal Authenticator.
Bonne connaissance du style d'architecture REST.
Application Client Postman natif installée.
Les fichiers json Oracle_Universal_Authenticator_REST_API.postman_collection.json, Oracle_Universal_Authenticator_Example_Environment.postman_environment.json ont été téléchargés.

Remarque : les administrateurs doivent prendre en compte les points suivants lors de la mise à jour des propriétés à l'aide des API REST :

Toute propriété précédemment personnalisée lors de l'installation, conformément à la section Customizing During Installation, sera écrasée. Si vous souhaitez conserver certaines de ces propriétés personnalisées, vous devez les ajouter à nouveau dans un thème, à l'aide de l'API REST décrite dans ce tutoriel.
Il n'existe aucun thème par défaut. Cela est vrai même si vous avez personnalisé des propriétés lors de l'installation, conformément à la section Customizing During Installation.
Les thèmes doivent être créés à l'aide de l'API REST selon les paramètres régionaux, si nécessaire.
Pour activer des thèmes, vous devez définir oua.themes.custom.distribution sur 1, comme indiqué plus loin dans ce tutoriel.
Une fois les thèmes activés, l'appareil contacte périodiquement le serveur OAA pour toute mise à jour et utilisera le thème une fois notifié. Cela écrase toutes les installations personnalisées lors de l'installation.
Toute mise à jour ultérieure des thèmes sera fournie au périphérique la prochaine fois que l'application client OUA contactera le serveur OAA.

Installer la collection Postman d'Oracle Advanced Authentication

Définition des paramètres d'environnement dans Postman

Remarque : les étapes ci-dessous peuvent varier en fonction de votre version de Postman.

Ouvrez Postman et sélectionnez Environnements dans votre espace de travail.
Conseil : par défaut, le portlet Jeu de transport - Services d'import est situé dans l'onglet Portail de l'onglet Administrer de la page Portal Builder.
Dans la boîte de dialogue Importer, sélectionnez ou supprimez le fichier Oracle_Universal_Authenticator_Example_Environment.postman_environment.json, puis cliquez sur Ouvrir.
Dans la liste des environnements affichée, à droite de l'environnement de l'exemple Oracle Universal Authenticator, cliquez sur les points de suspension, puis sur Dupliquer.
Dans Oracle Universal Authenticator Example Environment Copy, qui apparaît au-dessus de l'environnement d'origine, cliquez sur l'icône et renommez-la en Oracle Universal Authenticator Environment for REST APIs.
Mettez à jour les variables d'environnement pour le nouvel environnement en entrant les valeurs suivantes pour Valeur initiale et Valeur actuelle. Une fois que vous avez terminé, cliquez sur Enregistrer :
- RELEASENAME : RELEASENAME affecté à la configuration Oracle Advanced Authentication, par exemple oaainstall.
- DRSS_URL : URL de l'adresse DRSS dans Oracle Advanced Authentication, par exemple https://oaa.example.com/oaa-drss.
- DRSS_USERNAME : nom utilisateur des API DRSS au format RELEASENAME-oaa-drss, par exemple oaainstall-oaa-drss.
- DRSS_PASSWORD : drssapikey pour la configuration d'Oracle Advanced Authentication.
Remarque : si vous ne connaissez pas RELEASENAME, DRSS_URL, DRSS_USERNAME et DRSS_PASSWORD, reportez-vous à Impression des détails de déploiement.

L'environnement se présente comme suit :
Cliquez sur la liste déroulante Environnement, puis sélectionnez l'environnement mis à jour dans la liste :

Importer la collection Postman

Pour importer la collection Postman de l'API REST Oracle Advanced Authentication, sélectionnez Collections > Importer.
Dans la boîte de dialogue Importer, sélectionnez ou supprimez Oracle_Universal_Authenticator_REST_API.postman_collection.json.

La collection doit s'afficher comme suit :

Tester les API de thème

Créer des thèmes de langue

Remarque : pour éviter les erreurs de vérification de certificat SSL, dans le menu latéral de navigation, accédez à Fichier > Paramètres et, dans l'onglet Général, désactivez Vérification de certificat SSL.

Dans cette section, vous allez créer des thèmes de langue pour les éléments que vous souhaitez personnaliser.

Dans l'onglet Collections, accédez à API REST Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez PUT updateLocale. Cette demande envoie une demande PUT à l'adresse oaa-drss/v1/themes/<locale> et crée un thème pour les paramètres régionaux dont vous avez besoin en fonction des informations du corps.

Modifiez ou supprimez des champs et des valeurs, le cas échéant.

Dans cet exemple, un thème pour la langue en_US est créé, oaa-drss/v1/themes/en_US et toutes les propriétés personnalisables sont mises à jour.

Pour la valeur de logo, vous devez convertir le fichier bmp en BASE64 à l'aide d'un utilitaire de votre choix, puis coller la valeur dans l'entrée logo.
Cliquez sur Envoyer.
Dans la réponse, confirmez que 204 No Content apparaît.
Créez d'autres thèmes pour les autres langues dont vous avez besoin. Dans cet exemple, un thème pour la langue française fr est créé, oaa-drss/v1/themes/fr, et toutes les propriétés personnalisables sont mises à jour.

Remarque : Tout le texte personnalisé doit être dans la langue du thème que vous créez.
Cliquez sur Envoyer.
Dans la réponse, confirmez que 204 No Content apparaît.
Répétez ce qui précède pour tous les autres thèmes linguistiques dont vous avez besoin, par exemple l'espagnol, etc.

Obtenir les thèmes linguistiques

Dans l'onglet Collections, accédez à API REST Oracle Universal Authenticator > API de gestion des thèmes
Sélectionnez GET getLocale. Cette demande effectue une demande GET vers l'adresse oaa-drss/v1/themes/locales et renvoie tous les thèmes créés.
Cliquez sur Envoyer.
Dans la réponse, confirmez que Status: 200 OK apparaît. La liste des thèmes est renvoyée.

Obtenir les propriétés personnalisées d'un thème

Dans l'onglet Collections, accédez à API REST Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez GET getLocale. Cette demande effectue une demande GET vers l'adresse oaa-drss/v1/themes/<locale> et renvoie toutes les propriétés personnalisées d'un thème.
Cliquez sur Envoyer.
Dans la réponse, confirmez que Status: 200 OK apparaît. La liste des propriétés personnalisées est renvoyée.

Remarque : outre les paramètres que vous avez personnalisés, vous verrez les valeurs par défaut des paramètres que vous n'avez pas personnalisés et d'autres paramètres qui ne sont pas personnalisables.

Activer les thèmes

Pour commencer à utiliser les thèmes dans l'application client Oracle Universal Authenticator, vous devez définir la propriété oua.themes.custom.distribution sur "1".

Dans l'onglet Collections, accédez à API REST Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez PUT oua.themes.custom.distribution. Cette demande effectue une demande PUT vers l'adresse oaa-drss/oua/property/v1, en définissant la propriété oua.themes.custom.distribution dans le corps. La valeur 1 active les thèmes et la valeur 0 les désactive. Valeur par défaut : 0.
Cliquez sur Envoyer.
Dans la réponse, confirmez que Status: 200 OK apparaît et que la réponse contient oua.themes.custom.distribution défini sur 1.

Mettre à jour un thème

Dans l'onglet Collections, accédez à API REST Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez PUT updateLocale. Cette demande envoie une demande PUT à l'adresse oaa-drss/v1/themes/<locale> et crée ou met à jour un thème pour l'environnement local dont vous avez besoin en fonction des informations du corps.

Mettez à jour ou supprimez des champs et des valeurs, le cas échéant.

Remarque : Outre les champs à mettre à jour, vous devez inclure tous les champs que vous avez précédemment personnalisés. Si vous n'ajoutez pas les propriétés précédemment personnalisées, elles seront remplacées par les valeurs par défaut.

Dans cet exemple, CPFT_TILE_IMAGE est mis à jour vers Enter your Example Company Username".
Cliquez sur Envoyer.
Dans la réponse, confirmez que 204 No Content apparaît.

Supprimer un thème

Supprimer un thème enlève entièrement le thème. Les administrateurs doivent être prudents lors de la suppression de thèmes et tenir compte des points suivants :

Si vous supprimez un thème, l'application client d'authentification client Oracle Universal Client continuera à utiliser le thème qu'elle utilisait avant sa suppression.
Si vous souhaitez que l'application client d'authentification client Oracle Universal Client revienne aux valeurs par défaut prêtes à l'emploi, vous pouvez effectuer l'une des opérations suivantes :
- Supprimez le thème, puis créez à nouveau le thème avec une valeur fictive.
- Ne supprimez pas le thème, mais mettez-le à jour avec "status": 0.

Dans l'onglet Collections, accédez à API REST Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez DEL deleteLocale. Cette demande effectue une demande DELETE vers l'adresse oaa-drss/v1/themes/<locale> et supprime le thème de l'environnement local indiqué.

Dans cet exemple, l'environnement linguistique espagnol (es) est supprimé.
Cliquez sur Envoyer.
Dans la réponse, confirmez que 204 No Content apparaît.
Si vous devez mettre à jour le thème avec une valeur fictive, utilisez PUT updateLocale pour mettre à jour le thème, puis cliquez sur Envoyer. Un message 204 No Content apparaît :

En savoir plus

Oracle Universal Authenticator

Informations en retour

Pour faire part de vos commentaires sur ce tutoriel, veuillez contacter idm_user_assistance_ww_grp@oracle.com

Remerciements

Auteur - Russ Hodgson

Ressources de formation supplémentaires

Explorez d'autres ateliers sur docs.oracle.com/learn ou accédez à d'autres contenus de formation gratuits sur le canal Oracle Learning YouTube. De plus, visitez le site education.oracle.com/learning-explorer pour devenir un explorateur Oracle Learning.

Pour obtenir la documentation produit, consultez le site Oracle Help Center.

Informations relatives au titre et au copyright

Customizing the Oracle Universal Authenticator Client Application Using REST APIs

G31293-01