(Legacy) REST-API-Referenz rest-api-reference

NOTE
Der Inhalt dieser Seite dient nur zu Informationszwecken. Die Verwendung dieser API erfordert eine aktuelle Lizenz von Adobe. Eine unbefugte Nutzung ist nicht zulässig.
IMPORTANT
Achten Sie darauf, über die neuesten Ankündigungen zu Produkten der Adobe Pass-Authentifizierung und Stilllegungszeitpläne auf der Seite Produktankündigungen auf dem Laufenden zu bleiben.

Drosselmechanismus

Die Adobe Pass-Authentifizierungs-REST-API wird von einem Einschränkungsmechanismus gesteuert.

Antwortformate response-formats

NOTE
Die in diesen Services bereitgestellten APIs können Antworten entweder in XML oder in JSON zurückgeben (für APIs, die eine Antwort zurückgeben). Es gibt drei verschiedene Möglichkeiten, das Antwortformat in der Anfrage anzugeben:
  • Setzen Sie HTTP Accept Header auf application/xml oder application/json.
  • Geben Sie in der Anfrage-Payload den Parameter format=xml oder format=json an.
  • Rufen Sie den Webservice-Endpunkt mit der Erweiterung .xml oder .json auf. Beispiel: /regcode.xml oder /regcode.json
Sie können eine der oben genannten Methoden angeben. Das Angeben mehrerer Methoden mit widersprüchlichen Formaten kann zu Fehlern oder unerwünschter Ausgabe führen.

REST-API-Endpunkte clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Webservices-Zusammenfassung web_srvs_summary

In der folgenden Tabelle sind die verfügbaren Web-Services für den Client-losen Ansatz aufgeführt. Klicken Sie auf die Endpunkte der Webdienste, um weitere Informationen zu erhalten (Beispielanfrage und -antwort, Eingabeparameter, HTTP-Methoden usw.)

Sr
Webdienst-Endpunkt
Beschreibung
.
Gehostet am
Aufgerufen von
1.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
Gibt den zufällig generierten Registrierungs-Code und den Anmeldeseiten-URI zurück.
2
Adobe
Reg Code Service
Intelligentes Gerät
2.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Gibt einen Registrierungs-Code-Eintrag mit Registrierungs-Code-UUID, Registrierungs-Code und Hash-Geräte-ID zurück
8
Adobe
Reg Code Service
Adobe Pass-Authentifizierung
3.
<SP_FQDN>/api/v1/config/
{requestorId}
Gibt die Liste der konfigurierten MVPDs für den Anforderer aus
5
Adobe
Adobe Pass
Authentication
Service
Anmeldung
Web
App
4.
<SP_FQDN>/api/v1/Authenticate
Startet den Authentifizierungsprozess durch Benachrichtigung des MVPD-Auswahlereignisses. Erstellt einen Datensatz in der Authentifizierungsdatenbank, der abgeglichen wird, wenn eine erfolgreiche Antwort von MVPD empfangen wird (Schritt 13)
7
Adobe
Adobe Pass
Authentication
Service
Anmeldung
Web
App
5.
SAML-Assertion-Verbraucher
Vorhandener SAML-Workflow zwischen Adobe Pass-Authentifizierung und MVPD
13
Adobe Pass
Authentication
Service
Adobe Pass-Authentifizierung
6.
<SP_FQDN>/api/v1/checkauthn/
{registrationCode}
Die Web-Anmeldeanwendung kann überprüfen, ob der Anmeldeversuch erfolgreich war
Adobe Pass
Authentifizierung
Service
Login
Web
App
7.
<SP_FQDN>/api/v1/tokens/authn
Ruft Authentifizierungs-Token-bezogene Metadaten ab
15
Adobe Pass
Authentication
Service
Intelligentes Gerät
8.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Löscht den Registrierungscode-Datensatz und gibt den Registrierungscode zur Wiederverwendung frei.
16
Adobe
Reg Code Service
Adobe Pass-Authentifizierung
9.
<SP_FQDN>/api/v1/authorize
Erhält die Autorisierungsantwort.
17
Adobe Pass
Authentication
Service
Intelligentes Gerät
10.
<SP_FQDN>/api/v1/checkauthn
Gibt an, ob das Gerät über ein nicht abgelaufenes Authentifizierungs-Token verfügt.
Adobe Pass
Authentication
Service
Intelligentes Gerät
11.
<SP_FQDN>/api/v1/tokens/authn
Gibt das AuthN-Token zurück, wenn vorhanden.
Adobe Pass
Authentication
Service
Intelligentes Gerät
12.
<SP_FQDN>/api/v1/tokens/authz
Gibt das AuthZ-Token zurück, wenn vorhanden.
Adobe Pass
Authentication
Service
Intelligentes Gerät
13.
<SP_FQDN>/api/v1/tokens/media
Gibt das Short Media Token zurück, falls gefunden. Entspricht /api/v1/mediatoken
Adobe Pass
Authentication
Service
Intelligentes Gerät
14.
<SP_FQDN>/api/v1/mediatoken
Abrufen eines Short Media-Tokens
Adobe Pass
Authentication
Service
Intelligentes Gerät
15.
<SP_FQDN>/api/v1/preauthorize
Ruft die Liste der vorab autorisierten Ressourcen ab
Adobe Pass
Authentication
Service
Intelligentes Gerät
16.
<SP_FQDN>/api/v1/preauthorize/{code}
Ruft die Liste der vorab autorisierten Ressourcen ab
Adobe Pass
Authentication
Service
Web-App anmelden
17.
<SP_FQDN>/api/v1/logout
Entfernen von AuthN- und AuthZ-Token aus dem Speicher
Adobe Pass
Authentifizierung
Service
Intelligentes Gerät
18.
<SP_FQDN>/api/v1/tokens/usermetadata
Ruft Benutzermetadaten nach Abschluss des Authentifizierungsflusses ab
Nicht zutreffend
Nicht zutreffend
Intelligentes Gerät
19.
<SP_FQDN>/api/v1/authenticate/freepreview
Erstellen eines Authentifizierungstokens für temporären Pass oder promotionellen temporären Pass
Nicht zutreffend
Adobe Pass
Authentication
Service
Intelligentes Gerät

REST API-Sicherheit security

Alle REST-APIs für die Adobe Pass-Authentifizierung müssen mit dem HTTPS-Protokoll aufgerufen werden, um eine sichere Kommunikation zu gewährleisten. Darüber hinaus sollten die meisten aufgerufenen APIs ein Zugriffstoken enthalten, das wie in der API-Dokumentation Zugriffstoken abrufen beschrieben wurde.

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b