Oracle Universal Authenticator-Clientanwendung mit REST-APIs anpassen

Einführung

Dieses Tutorial zeigt, wie Sie die Oracle Universal Authenticator-Clientanwendung mit REST-APIs und Postman anpassen.

Voraussetzungen

Bevor Sie mit diesem Tutorial beginnen, müssen Sie Folgendes haben:

Lesen und verstehen Sie Anpassen der Oracle Universal Authenticator-Clientanwendung.
Eine ausgeführte Oracle Advanced Authentication-Installation, die mit Oracle Universal Authenticator bereitgestellt wird.
Installierte Oracle Universal Authenticator-Clientanwendung auf Geräten gemäß Oracle Universal Authenticator-Clientanwendung installieren.
Vertrautheit mit dem REST-Architekturstil.
Die Native Postman Client-Anwendung ist installiert.
Die json-Dateien Oracle_Universal_Authenticator_REST_API.postman_collection.json, Oracle_Universal_Authenticator_Example_Environment.postman_environment.json wurden heruntergeladen.

Hinweis: Administratoren sollten Folgendes beachten, wenn sie Eigenschaften mit REST-APIs aktualisieren:

Alle Eigenschaften, die zuvor während der Installation gemäß Anpassen während der Installation angepasst wurden, werden überschrieben. Wenn Sie einige dieser benutzerdefinierten Eigenschaften beibehalten möchten, müssen Sie sie erneut in einem Theme hinzufügen. Verwenden Sie dazu die in diesem Tutorial beschriebenen REST-APIs.
Standardmäßig sind keine Themes vorhanden. Dies gilt auch, wenn Sie die Eigenschaften während der Installation gemäß Anpassen während der Installation angepasst haben.
Themes müssen nach Bedarf mit der REST-API pro Gebietsschema erstellt werden.
Um Themes zu aktivieren, müssen Sie oua.themes.custom.distribution wie später in diesem Tutorial gezeigt auf 1 setzen.
Sobald Themes aktiviert sind, kontaktiert das Gerät regelmäßig den OAA-Server für Aktualisierungen und verwendet das Theme, sobald es benachrichtigt wird. Dadurch werden alle Installationen überschrieben, die während der Installation angepasst wurden.
Alle nachfolgenden Aktualisierungen der Themes werden dem Gerät zugestellt, wenn die OUA-Clientanwendung das nächste Mal den OAA-Server kontaktiert.

Oracle Advanced Authentication Postman Collection installieren

Umgebungsparameter in Postman festlegen

Hinweis: Die folgenden Schritte können je nach Postman-Version variieren.

Öffnen Sie Postman, und wählen Sie in Ihrem Workspace Umgebungen aus.
Klicken Sie auf Importieren.
Wählen Sie im Dialogfeld Importieren die Option Oracle_Universal_Authenticator_Example_Environment.postman_environment.json aus, oder löschen Sie sie, und klicken Sie auf Öffnen.
Klicken Sie in der angezeigten Umgebungsliste rechts neben Beispielumgebung für Oracle Universal Authenticator auf die Auslassungspunkte und dann auf Duplizieren.
Klicken Sie unter Oracle Universal Authenticator Example Environment Copy, das über der ursprünglichen Umgebung angezeigt wird, auf die Auslassungspunkte, und benennen Sie sie in Oracle Universal Authenticator Environment for REST APIs um.
Aktualisieren Sie die Umgebungsvariablen für die neue Umgebung, indem Sie die folgenden Werte für Anfangswert und Aktueller Wert eingeben. Klicken Sie anschließend auf Speichern:
- RELEASENAME: Die dem Oracle Advanced Authentication-Setup zugewiesene RELEASENAME, z.B. oaainstall.
- DRSS_URL: Die URL für den DRSS-Endpunkt in Oracle Advanced Authentication. Beispiel: https://oaa.example.com/oaa-drss.
- DRSS_USERNAME: Der Benutzername für DRSS-APIs im Format RELEASENAME-oaa-drss, z.B. oaainstall-oaa-drss.
- DRSS_PASSWORD: drssapikey für das Setup von Oracle Advanced Authentication.
Hinweis: Wenn Sie RELEASENAME, DRSS_URL, DRSS_USERNAME und DRSS_PASSWORD nicht kennen, finden Sie weitere Informationen unter Deployment-Details drucken.

Die Umgebung sieht in etwa wie folgt aus:
Klicken Sie auf die Dropdown-Liste Umgebung, und wählen Sie die aktualisierte Umgebung aus der Liste aus:

Postman Collection importieren

Um die Postman-Collection der REST-API für Oracle Advanced Authentication zu importieren, wählen Sie Collections > Importieren aus.
Wählen Sie im Dialogfeld Importieren die Option Oracle_Universal_Authenticator_REST_API.postman_collection.json aus, oder löschen Sie sie.

Die Sammlung sollte wie folgt angezeigt werden:

Theme-APIs testen

Sprach-Themes erstellen

Hinweis: Um Fehler bei der SSL-Zertifikatverifizierung zu vermeiden, navigieren Sie im Hamburger-Navigationsmenü zu Datei > Einstellungen, und deaktivieren Sie auf der Registerkarte "Allgemein" die SSL-Zertifikatverifizierung.

In diesem Abschnitt erstellen Sie Sprachthemen für die Elemente, die Sie anpassen möchten.

Navigieren Sie auf der Registerkarte "Sammlungen" zu Oracle Universal Authenticator-REST-API > Themes Management-APIs.
Wählen Sie PUT updateLocale. Diese Anforderung erstellt eine PUT-Anforderung an den oaa-drss/v1/themes/<locale>-Endpunkt und basierend auf den Informationen im Body ein Theme für das gewünschte Gebietsschema.

Ändern oder entfernen Sie Felder und Werte nach Bedarf.

In diesem Beispiel wird ein Theme für die Sprache en_US erstellt, oaa-drss/v1/themes/en_US, und alle anpassbaren Eigenschaften werden aktualisiert.

Für den Logowert müssen Sie die bmp-Datei mit einem Utility Ihrer Wahl in BASE64 konvertieren und den Wert in den Eintrag logo einfügen.
Klicken Sie auf Senden.
Bestätigen Sie in der Antwort, dass 204 No Content angezeigt wird.
Erstellen Sie weitere Themes für die anderen Sprachen, die Sie benötigen. In diesem Beispiel wird ein Theme für die französische Sprache fr erstellt, oaa-drss/v1/themes/fr, und alle anpassbaren Eigenschaften werden aktualisiert.

Hinweis: Der gesamte angepasste Text muss in der Sprache für das Thema enthalten sein, das Sie erstellen.
Klicken Sie auf Senden.
Bestätigen Sie in der Antwort, dass 204 No Content angezeigt wird.
Wiederholen Sie das oben genannte für alle anderen Sprachthemen, die Sie benötigen, z. B. Spanisch usw.

Holen Sie sich Sprach-Themes

Navigieren Sie auf der Registerkarte "Sammlungen" zu Oracle Universal Authenticator-REST-API > Themes Management-APIs
Wählen Sie GET getLocale aus. Diese Anforderung sendet eine GET-Anforderung an den oaa-drss/v1/themes/locales-Endpunkt und gibt alle erstellten Themes zurück.
Klicken Sie auf Senden.
Bestätigen Sie in der Antwort, dass Status: 200 OK angezeigt wird. Die Liste der Themen wird zurückgegeben.

Angepasste Eigenschaften für ein Theme abrufen

Navigieren Sie auf der Registerkarte "Sammlungen" zu Oracle Universal Authenticator-REST-API > Themes Management-APIs.
Wählen Sie GET getLocale aus. Diese Anforderung erstellt eine GET-Anforderung an den oaa-drss/v1/themes/<locale>-Endpunkt und gibt alle benutzerdefinierten Eigenschaften für ein Theme zurück.
Klicken Sie auf Senden.
Bestätigen Sie in der Antwort, dass Status: 200 OK angezeigt wird. Die Liste der benutzerdefinierten Eigenschaften wird zurückgegeben.

Hinweis: Neben den von Ihnen angepassten Parametern werden Standardwerte für nicht angepasste Parameter und andere Parameter angezeigt, die nicht anpassbar sind.

Themes aktivieren

Um die Themes in der Oracle Universal Authenticator-Clientanwendung zu verwenden, müssen Sie die Eigenschaft oua.themes.custom.distribution auf "1" setzen.

Navigieren Sie auf der Registerkarte "Sammlungen" zu Oracle Universal Authenticator-REST-API > Themes Management-APIs.
Wählen Sie PUT oua.themes.custom.distribution. Diese Anforderung sendet eine PUT-Anforderung an den Endpunkt oaa-drss/oua/property/v1, indem die Eigenschaft oua.themes.custom.distribution im Body festgelegt wird. Der Wert 1 aktiviert Themes, und der Wert 0 deaktiviert die Themes. Standardwert ist 0.
Klicken Sie auf Senden.
Stellen Sie in der Antwort sicher, dass Status: 200 OK angezeigt wird und dass die Antwort oua.themes.custom.distribution enthält, das auf 1 gesetzt ist.

Ein Theme aktualisieren

Navigieren Sie auf der Registerkarte "Sammlungen" zu Oracle Universal Authenticator-REST-API > Themes Management-APIs.
Wählen Sie PUT updateLocale. Diese Anforderung stellt eine PUT-Anforderung an den oaa-drss/v1/themes/<locale>-Endpunkt her und erstellt oder aktualisiert ein Theme für das gewünschte Gebietsschema basierend auf den Informationen im Body.

Aktualisieren oder entfernen Sie Felder und Werte nach Bedarf.

Hinweis: Neben den Feldern, die Sie aktualisieren möchten, müssen Sie alle Felder einschließen, die Sie zuvor angepasst haben. Wenn Sie die zuvor angepassten Eigenschaften nicht hinzufügen, werden sie mit den Standardwerten überschrieben.

In diesem Beispiel wird CPFT_TILE_IMAGE in Enter your Example Company Username" aktualisiert.
Klicken Sie auf Senden.
Bestätigen Sie in der Antwort, dass 204 No Content angezeigt wird.

Theme löschen

Wenn Sie ein Theme löschen, wird es vollständig entfernt. Administratoren sollten beim Löschen von Themes vorsichtig sein und Folgendes beachten:

Wenn Sie ein Theme löschen, verwendet die Oracle Universal Client Authenticator-Clientanwendung weiterhin das Theme, das sie verwendet hat, bevor das Theme gelöscht wurde.
Wenn die Oracle Universal Client Authenticator-Clientanwendung auf die Out-of-the-box-Standardwerte zurückgesetzt werden soll, können Sie einen der folgenden Schritte ausführen:
- Löschen Sie das Theme, und erstellen Sie das Theme erneut mit einem Dummy-Wert.
- Löschen Sie das Theme nicht, sondern aktualisieren Sie es stattdessen mit "status": 0.

Navigieren Sie auf der Registerkarte "Sammlungen" zu Oracle Universal Authenticator-REST-API > Themes Management-APIs.
Wählen Sie DEL deleteLocale aus. Diese Anforderung erstellt eine DELETE-Anforderung an den Endpunkt oaa-drss/v1/themes/<locale> und löscht das Theme für das angegebene Gebietsschema.

In diesem Beispiel wird das spanische Gebietsschema (es) gelöscht.
Klicken Sie auf Senden.
Bestätigen Sie in der Antwort, dass 204 No Content angezeigt wird.
Wenn Sie das Theme mit einem Dummy-Wert aktualisieren müssen, verwenden Sie PUT updateLocale, um das Theme zu aktualisieren, und klicken Sie auf Senden. Eine 204 No Content-Meldung wird angezeigt:

Weitere Informationen

Oracle Universal Authenticator

Feedback

Um Feedback zu diesem Tutorial zu geben, wenden Sie sich bitte an idm_user_assistance_ww_grp@oracle.com

Danksagungen

Autor - Russ Hodgson

Weitere Lernressourcen

Sehen Sie sich andere Übungen zu docs.oracle.com/learn an, oder greifen Sie im Oracle Learning YouTube-Channel auf weitere kostenlose Lerninhalte zu. Besuchen Sie außerdem education.oracle.com/learning-explorer, um Oracle Learning Explorer zu werden.

Die Produktdokumentation finden Sie im Oracle Help Center.

Titel und Copyright-Informationen

Customizing the Oracle Universal Authenticator Client Application Using REST APIs

G31290-01