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

Présentation

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

Préalables

Avant de commencer ce tutoriel, vous devez avoir :

Lire et comprendre Personnalisation de l'application client Oracle Universal Authenticator.
Une 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 des appareils conformément à l'installation de l'application client Oracle Universal Authenticator.
Connaissance du style d'architecture REST.
Application de client Native Postman 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.

Note : Les administrateurs doivent être conscients des éléments 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 rubrique Personnalisation lors de l'installation sera remplacé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.
Aucun thème n'existe par défaut. Cela est vrai même si vous avez personnalisé les propriétés lors de l'installation conformément à la rubrique Personnalisation lors de l'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 régler oua.themes.custom.distribution à 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 qui ont été personnalisées pendant l'installation.
Toute mise à jour ultérieure des thèmes sera livrée à l'appareil la prochaine fois que l'application client OUA contactera le serveur OAA.

Installer la collection Postman d'Oracle Advanced Authentication

Définir les paramètres d'environnement dans Postman

Note : Les étapes ci-dessous peuvent varier en fonction de votre version de Postman.

Ouvrez Postman et, dans votre espace de travail, sélectionnez Environnements.
Cliquez sur Importer.
Dans la boîte de dialogue Importer, sélectionnez ou déposez Oracle_Universal_Authenticator_Example_Environment.postman_environment.json, puis cliquez sur Ouvrir.
Dans la liste d'environnements affichée, à droite de Exemple d'environnement 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 initial, cliquez sur les points de suspension et renommez-les 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 courante. Lorsque vous avez terminé, cliquez sur Enregistrer :
- RELEASENAME : RELEASENAME affecté à la configuration Oracle Advanced Authentication, par exemple oaainstall.
- DRSS_URL : URL du point d'extrémité DRSS dans Oracle Advanced Authentication, par exemple https://oaa.example.com/oaa-drss.
- DRSS_USERNAME : Nom d'utilisateur pour les API DRSS au format RELEASENAME-oaa-drss, par exemple oaainstall-oaa-drss.
- DRSS_PASSWORD : drssapikey pour la configuration d'Oracle Advanced Authentication.
Note : Si vous ne connaissez pas les paramètres RELEASENAME, DRSS_URL, DRSS_USERNAME et DRSS_PASSWORD, voir Impression des détails du déploiement.

L'environnement ressemblera à ce qui 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 d'Oracle Advanced Authentication, sélectionnez Collections (Collections) > Import (Importer).
Dans la boîte de dialogue Importer, sélectionnez ou déposez 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

Note : Pour empêcher les erreurs de vérification de certificat SSL, dans le menu hamburger de navigation, naviguez jusqu'à Fichier > Paramètres et, dans l'onglet Général, désactivez la vérification de certificat SSL.

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

Dans l'onglet Collections, naviguez jusqu'à API REST d'Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez PUT updateLocale. Cette demande envoie une demande PUT au point d'extrémité 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, au besoin.

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

Note : Tout le texte personnalisé doit être dans la langue du thème que vous créez.
Cliquez sur Envoyer.
Dans la réponse, vérifiez que 204 No Content s'affiche.
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 de langue

Dans l'onglet Collections, naviguez jusqu'à API REST d'Oracle Universal Authenticator > API de gestion des thèmes
Sélectionnez GET getLocale. Cette demande soumet une demande GET au point d'extrémité oaa-drss/v1/themes/locales et retourne tous les thèmes créés.
Cliquez sur Envoyer.
Dans la réponse, vérifiez que Status: 200 OK s'affiche. La liste des thèmes est retournée.

Obtenir des propriétés personnalisées pour un thème

Dans l'onglet Collections, naviguez jusqu'à API REST d'Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez GET getLocale. Cette demande soumet une demande GET au point d'extrémité oaa-drss/v1/themes/<locale> et retourne toutes les propriétés personnalisées d'un thème.
Cliquez sur Envoyer.
Dans la réponse, vérifiez que Status: 200 OK s'affiche. La liste des propriétés personnalisées est retournée.

Note : Outre les paramètres que vous avez personnalisés, vous verrez des valeurs par défaut pour les 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 de l'application client Oracle Universal Authenticator, vous devez régler la propriété oua.themes.custom.distribution à "1".

Dans l'onglet Collections, naviguez jusqu'à API REST d'Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez PUT oua.themes.custom.distribution. Cette demande soumet une demande PUT au point d'extrémité oaa-drss/oua/property/v1, en définissant la propriété oua.themes.custom.distribution dans le corps. Une valeur de 1 active les thèmes et une valeur de 0 les désactive. La valeur par défaut est 0.
Cliquez sur Envoyer.
Dans la réponse, vérifiez que Status: 200 OK s'affiche et que la réponse contient oua.themes.custom.distribution réglé à 1.

Mettre à jour un thème

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

Mettez à jour ou supprimez des champs et des valeurs, au besoin.

Note : Outre les champs à mettre à jour, vous devez inclure tous les champs que vous avez personnalisés précédemment. 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 à Enter your Example Company Username".
Cliquez sur Envoyer.
Dans la réponse, vérifiez que 204 No Content s'affiche.

Supprimer un thème

La suppression d'un thème supprime entièrement le thème. Les administrateurs doivent faire attention lors de la suppression des thèmes et être conscients des éléments suivants :

Si vous supprimez un thème, l'application client Oracle Universal Client Authenticator continuera d'utiliser le thème utilisé avant la suppression du thème.
Si vous souhaitez que l'application client Oracle Universal Client Authenticator rétablisse les valeurs par défaut prêtes à l'emploi, vous pouvez effectuer l'une des opérations suivantes :
- Supprimez le thème, puis recréez-le avec une valeur fictive.
- Ne supprimez pas le thème, mais mettez-le à jour avec "status": 0.

Dans l'onglet Collections, naviguez jusqu'à API REST d'Oracle Universal Authenticator > API de gestion des thèmes.
Sélectionnez DEL deleteLocale. Cette demande envoie une demande DELETE au point d'extrémité oaa-drss/v1/themes/<locale> et supprime le thème pour les paramètres régionaux spécifiés.

Dans cet exemple, les paramètres régionaux espagnols (es) sont supprimés.
Cliquez sur Envoyer.
Dans la réponse, vérifiez que 204 No Content s'affiche.
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 s'affiche :

En savoir plus

Oracle Universal Authenticator

Rétroaction

Pour obtenir des commentaires sur ce tutoriel, veuillez communiquer avec idm_user_assistance_ww_grp@oracle.com

Remerciements

Auteur - Russ Hodgson

Autres ressources d'apprentissage

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

Pour obtenir la documentation sur le produit, visitez Oracle Help Center.

Informations sur le titre et les droits d'auteur

Customizing the Oracle Universal Authenticator Client Application Using REST APIs

G31292-01