REST-APIs für erweiterte Authentifizierung von Oracle mit Postman verwenden
Einführung
In diesem Tutorial wird gezeigt, wie Sie REST-API-Aufrufe für die erweiterte Oracle-Authentifizierung mit Postman ausführen (Software, die normalerweise für REST-API-Tests verwendet wird).
Ziele
Mit den REST-APIs für die erweiterte Authentifizierung von Oracle können Sie die erweiterte Authentifizierung von Oracle mit REST-Clients integrieren, sodass sie die erweiterte Authentifizierung von Oracle konfigurieren und verwalten können. Eine vollständige Liste der REST-API-Endpunkte finden Sie unter OAA-Admin-API.
In diesem Tutorial erfahren Sie, wie Sie die Oracle Advanced Authentication Postman-Sammlung herunterladen und importieren und einige der gängigsten Postman-Anforderungen testen.
Voraussetzungen
Um dieses Tutorial abzuschließen, benötigen Sie Folgendes:
- Eine Oracle Advanced Authentication-Installation wird ausgeführt
- Oracle Mobile Authenticator auf einem mobilen Gerät installiert
- Vertrautheit mit dem REST-Architekturstil
- Nativer Postman-Client v8.0.6 oder höher installiert
- Die json-Dateien Oracle_Advanced_Authentication_REST_API.postman_collection.json, Oracle_Advanced_Authentication_Example_Environment.postman_environment.json
Oracle Advanced Authentication Postman Collection installieren
Umgebungsparameter in Postman festlegen
-
Öffnen Sie Postman, und wählen Sie Datei > Importieren aus.
-
Wählen Sie im Dialogfeld Importieren in der Registerkarte Datei die Option Dateien hochladen aus. Wählen Sie Oracle_Advanced_Authentication_Example_Environment.postman_environment.json, und klicken Sie auf Open.
-
Klicken Sie im Menü auf der linken Seite auf
.
-
Klicken Sie in der angezeigten Umgebungsliste rechts neben der Oracle Advanced Authentication Example-Umgebung auf die Auslassungspunkte und anschließend auf Duplizieren.
-
Klicken Sie unter Oracle Advanced Authentication Example Environment Copy, das über der ursprünglichen Umgebung angezeigt wird, auf die Auslassungen, und benennen Sie sie in
Oracle Advanced Authentication 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 und anschließend auf der Registerkarte auf X, um sie zu schließen:
- oaa-admin: Oracle Advanced Authentication Hostname und Admin Port. Beispiel:
https://oaa.example.com
- oaa-policy: Oracle Advanced Authentication Hostname und Policy-Port. Beispiel:
https://oaa.example.com
- oaa-runtime: Oracle Advanced Authentication Hostname und Laufzeitport. Beispiel:
https://oaa.example.com
- RELEASENAME: Der
RELEASENAME
, der dem Setup der erweiterten Oracle-Authentifizierung zugewiesen ist, z.B.oaainstall
. Dieser Wert wird bei der Installation von OAA fürcommon.deployment.name
übergeben. - oaapolicyapikey:
oaapolicyapikey
für das Setup der erweiterten Oracle-Authentifizierung. Beispiel:a5764d4ef6b71129f38a2d8ddc88b6060653d3c8
. Dieser Wert wird bei der Installation von OAA fürinstall.global.policyapikey
übergeben. - oaaapikey:
oaaapikey
für das Setup der erweiterten Oracle-Authentifizierung. Beispiel:a5764d4ef6b71129f38a2d8ddc88b6060653d3c8
. Dieser Wert wird bei der Installation von OAA fürinstall.global.uasapikey
übergeben.
Hinweis: Wenn Sie die URLs für
oaa-admin
,oaa-policy
undoaa-runtime
(spui) nicht kennen, führen Sie im OAA Kubernetes-Cluster Folgendes aus:kubectl get pods -n <namespace> | grep 'oaa-admin\|oaa-policy\|spui'
Führen Sie dann für jeden Pod Folgendes aus, um die URL abzurufen:
kubectl exec -it <pod> -n <namespace> -- cat serviceurl.txt
Die Umgebung sollte wie folgt aussehen:
Beschreibung der Abbildung Environment.jpg
Hinweis: Bei den URL-Werten im obigen Beispiel wird eine OAA-Installation mit NodePort vorausgesetzt. Daher werden Portnummern für jeden der Pods in den URLs definiert. Wenn die OAA-Installation einen Ingress-Traffic verwendet, verwenden Sie in allen Fällen die Ingress-URL.
- oaa-admin: Oracle Advanced Authentication Hostname und Admin Port. Beispiel:
-
Klicken Sie auf die Dropdown-Liste Umgebung, und wählen Sie die aktualisierte Umgebung aus der Liste aus:
Postman-Sammlung importieren
-
To import the Oracle Advanced Authentication REST API Postman collection, on the Postman main page, select File > Import.
-
Wählen Sie im Dialogfeld Importieren in der Registerkarte Datei die Option Dateien hochladen aus. Wählen Sie die Datei Oracle_Advanced_Authentication_REST_API.postman_collection.json aus, und klicken Sie auf Öffnen und dann auf Importieren.
Klicken Sie im linken Menü auf Sammlungen. Die Collection sollte wie folgt angezeigt werden:
REST-APIs testen
In diesem Abschnitt führen Sie einige der Anforderungen in der Postman-Sammlung für die erweiterte Oracle-Authentifizierung aus.
Hinweis: Um Fehler bei der SSL-Zertifikatsverifizierung zu vermeiden, navigieren Sie zu Datei > Einstellungen, und setzen Sie auf der Registerkarte Allgemein die Option SSL-Zertifikatsverifizierung auf OFF.
API-Integrations-Agent erstellen
In diesem Abschnitt erstellen Sie einen API-Integrations-Agent.
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for Defining System Entities -> agent/v1.
-
Wählen Sie Neuen API-Integrations-Agent erstellen aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa-policy/agent/v1
-Endpunkt her und erstellt einen API-Integrations-Agent mit dem NamenAPIAgent
basierend auf den Informationen im Body: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Antwortbody Details zum erstellten Integrations-Agent anzeigt. Notieren Sie sich die zurückgegebeneagentgid
, da diese in den folgenden Abschnitten verwendet wird.
Versicherungsebene erstellen
In diesem Abschnitt erstellen Sie eine Sicherheitsstufe für den erstellten Integrations-Agent.
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for Defining System Entities -> AssuranceLevel/v1.
-
Wählen Sie Sicherheitsebene definieren. Diese Anforderung stellt eine POST-Anforderung an den
/oaa-policy/assuranceLevel/v1
-Endpunkt her und erstellt eine Sicherheitsstufe für den Integrations-Agent mit dem NamenAssuranceLevel1
. Bearbeiten Sie im Body den Wert füragentid
so, dass er mit dem zuvor zurückgegebenen Wert übereinstimmt: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Antwortbody Details zur erstellten Sicherheitsebene anzeigt.
Gruppen erstellen
In diesem Abschnitt erstellen Sie eine Aktionsgruppe für Faktoren und eine Gruppe für IP-Adressen. Diese Gruppen werden später einer Policy und Regel für den zuvor erstellten Integrations-Agent und die zuvor erstellte Sicherheitsstufe zugewiesen.
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for Defining System Entities -> group/v1.
-
Wählen Sie Neue Faktorgruppe erstellen aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa-policy/group/v1
-Endpunkt her und erstellt eine Gruppe für den Agent mit dem NamenFactorRuleGrp1
. Bearbeiten Sie im Text den Wert füragentid
so, dass er mit dem zuvor zurückgegebenen Wert übereinstimmt. In diesem Beispiel legt die Gruppe zwei Faktoren fest:ChallengeEmail
undChallengeOMATOTP
: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Antwortbody Details zur erstellten Gruppe anzeigt. Notieren Sie sich diegroupid
, da diese später verwendet wird, um diese Gruppe einer Policy zuzuweisen. -
Wählen Sie in der aktuellen Sammlung unter group/v1 die Option Neue Gruppe vom Typ IP erstellen aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa-policy/group/v1
-Endpunkt her und erstellt eine Gruppe für den Integrations-Agent mit dem NamenSecureIP
. Bearbeiten Sie im Text den Wert füragentgid
so, dass er mit dem zuvor zurückgegebenen Wert übereinstimmt. In diesem Beispiel setzt der Wertabschnitt die IPs von198.51.100.1
auf198.51.100.3
: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Antwortbody Details zur erstellten Gruppe anzeigt. Notieren Sie sich diegroupid
, da diese später verwendet wird, um diese Gruppe einer Policy zuzuweisen.
Policy erstellen
In diesem Abschnitt erstellen Sie eine Police für die zuvor erstellte Sicherheitsstufe und den Integrations-Agent.
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for Defining System Entities -> policy/v1.
-
Wählen Sie Neue Policy erstellen aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa-policy/policy/v1
-Endpunkt her und erstellt eine Policy für den zuvor erstellten Integrations-Agent und die zuvor erstellte SicherheitsstufePolicy1
. Bearbeiten Sie im Body den Wert füragentgid
so, dass er mit dem zuvor zurückgegebenen Wert übereinstimmt: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Antwortbody Details zur erstellten Policy anzeigt. Notieren Sie sich diepolicygid
, da diese später dieser Policy eine Regel zugewiesen wird.
Policy-Regel erstellen
In diesem Abschnitt erstellen Sie eine Policy-Regel für die Policy.
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for Defining System Entities -> policy/v1 -> {policygid} -> rule > {ruleid}.
-
Wählen Sie Neue Regel für die Policy definieren aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa-policy/policy/v1/:policygid/rule
-Endpunkt her. Bearbeiten Sie auf der Registerkarte "Parameter" den Wert fürpolicygid
so, dass er mit dem zuvor zurückgegebenen Wert für die Policy übereinstimmt. Bearbeiten Sie im Body unterconditionMap
die Werte unterexpression
undvalues
, und legen Sie den Wert aufgroupId
der zuvor erstellten GruppeSecureIP
fest. Legen Sie unterresults
den Wert füraction
so fest, dass er mitgroupId
der zuvor erstellten GruppeFactorGroup1
übereinstimmt:Beschreibung der Abbildung createrule.jpg
Im obigen Beispiel gibt die Regel an, dass wenn die IP-Adresse des Endbenutzers, der die Authentifizierungsanforderung ausführt, einer der in der Gruppe
SecureIP
definierten ist, die Faktoren für die Authentifizierung auf die inFactorGroup1
definierten Faktoren festlegen. -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Antwortbody Details zur erstellten Regel anzeigt. Notieren Sie sich dierulegid
für eine spätere Referenz.
Benutzereinstellungen erstellen
In diesem Abschnitt erstellen Sie einen Benutzer user1
und registrieren dessen Faktorvoreinstellungen.
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for User Preferences -> preferences/v1.
-
Wählen Sie Benutzervoreinstellungen werden erstellt/registriert aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa/runtime/preferences/v1
-Endpunkt her. Geben Sie im Text die zu erstellendeuserId
und die entsprechendegroupId
ein. Im folgenden Beispiel wirduser1
in der GruppeDefault
erstellt und registriert den Benutzer für E-Mail- und OMATOTP-Faktoren. Ändern Sie den Wert der E-Mail-Adresse in eine gültige E-Mail-Adresse. Ändern Siesecret_key
für OMATOTP in einen Wert Ihrer Wahl, der in der Oracle Mobile Authenticator-Anwendung verwendet werden soll. -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird und der Benutzer und seine Voreinstellungen erfolgreich erstellt und registriert wurden.
Challenge für Benutzer, Initialisieren der Challenge und Validieren
In diesem Abschnitt testen Sie eine Benutzerherausforderung für user1
anhand der Regel, die vorher unter Policy-Regel erstellen erstellt wurde. Wenn die Regel validiert wird, werden die für diesen Benutzer registrierten Faktoren zurückgegeben. Nachdem Sie einen zu authentifizierenden Faktor gewählt haben, wird eine Initialisierungsanforderung gesendet, um den OTP für diesen Faktor aufzufordern. Ein gültiger Faktor OTP wird eingegeben und validiert.
Stellen Sie vor dem Starten dieses Abschnitts sicher, dass für Ihren Oracle Mobile Authenticator ein Oracle-Account hinzugefügt wurde, wobei Key
auf den Wert secret_key
gesetzt ist, der unter Benutzervoreinstellungen erstellen eingegeben wurde. Siehe Account in Oracle Mobile Authenticator konfigurieren
-
On the Collections tab, navigate to Oracle Advanced Authentication REST API > REST API for User Challenge -> Challenge User, Initalize Challenge, Validate Challenge.
-
Wählen Sie Herausforderungsbenutzer aus. Diese Anforderung stellt eine POST-Anforderung an den
/oaa/runtime/authn/v1
-Endpunkt her. Geben Sie im Text dieuserId
füruser1
und die entsprechendegroupId
ein. Im folgenden Beispiel wird die Challenge füruser1
mit dem API Integration Agent durchgeführt, den Sie zuvor unter Integrations-Agent-API erstellen erstellt haben. Geben Sie die Werte fürclientSecret
undclientId
für diesen API-Agent ein. Geben Sie inipAddr
eine IP ein, die in der zuvor erstellten GruppeSecureIP
definiert wurde: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird. EineOAA-40001
-Nachricht mit der AngabeAuthentication Required
wird zurückgegeben. Die füruser1
(E-Mail und OMATOTP) registrierten Faktoren werden zusammen mit einemcorrelationId
zurückgegeben. Notieren Sie sich diecorrelationId
, die in nachfolgenden Anforderungen verwendet werden soll: -
Wählen Sie unter Challenge-Benutzer, Challenge initiieren, Herausforderung validieren die Option Challenge initialisieren aus. Dadurch wird eine PUT-Anforderung an den
/oaa/runtime/authn/v1
-Endpunkt gesendet. Geben Sie im Text diecorrelationId
ein, die in der vorherigen Antwort zurückgegeben wurde. In diesem Beispiel wird der OMATOTP-Faktor verwendet: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird. EineOAA-40001
-Nachricht mit der AngabeAuthentication Required
für OMATOTP wird zurückgegeben. Für die zugehörigecorrelationId
wird einnonce
-Wert zurückgegeben. Notieren Sie sich den Wertnonce
, um die nächste Anforderung zu verwenden: -
Wählen Sie unter Herausforderungsbenutzer, Herausforderung initiieren, Herausforderung validieren die Option Challenge validieren aus. Dadurch wird eine PUT-Anforderung an den
/oaa/runtime/authn/v1
-Endpunkt gesendet. Geben Sie im BodycorrelationId
undnonce
ein, die in der vorherigen Antwort zurückgegeben wurden. Geben Sie einen gültigen OTP aus Oracle Mobile Authenticator inChallengeAnswer
ein: -
Klicken Sie auf Senden.
-
Bestätigen Sie in der Antwort, dass
Status: 200 OK
angezeigt wird. Wenn die Validierung des OTP erfolgreich war, wird eineOAA-40004
-Nachricht zurückgegeben, die angibt, dass der BenutzerAuthenticated
ist:
Weitere Informationen
- Oracle Advanced Authentication
- OAA-Admin-API
- OAA-Laufzeit-API
- Oracle RADIUS Agent mit erweiterter Oracle-Authentifizierung für Multifaktor-Authentifizierung verwenden
- Integration von Oracle Access Management mit Oracle Advanced Authentication
Feedback
Um Feedback zu diesem Tutorial zu geben, wenden Sie sich 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 auf weitere Inhalte für kostenloses Lernen im Oracle Learning YouTube-Kanal zu. Außerdem besuchen Sie education.oracle.com/learning-explorer, um Oracle Learning Explorer zu werden.
Produktdokumentation finden Sie im Oracle Help Center.
Use Oracle Advanced Authentication REST APIs with Postman
F53380-01
February 2022
Copyright © 2022, Oracle and/or its affiliates.