DokumentationAdobe PassAdobe Pass-Authentifizierung

Abrufen der Konfiguration für einen bestimmten Dienstleister

Letzte Aktualisierung: 5. März 2025
  • Themen:
  • Authentifizierung
IMPORTANT
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
Die REST-API-V2-Implementierung ist an die Dokumentation Drosselungsmechanismus gebunden.
Related Articles
Stellen Sie sicher, dass Sie auch die häufig gestellten Fragen REST API V2 besuchen.

Anfrage

HTTP
Pfad
/api/v2/{serviceProvider}/configuration
Methode
GET
Pfadparameter
serviceProvider
Die interne eindeutige Kennung, die dem Dienstleister während des Onboarding-Prozesses zugeordnet ist.
required
Abfrageparameter
Profil
-
fakultativ
Kopfzeilen
Autorisierung
Die Generierung der Bearer-Token-Payload wird in der Dokumentation zur -Kopfzeile.
required
ap-device-identifier
Die Erstellung der Payload der Gerätekennung wird in der Header-Dokumentation AP-Device-Identifier beschrieben.
required
x-device-info
Die Erzeugung der Payload mit Geräteinformationen wird in der Header-Dokumentation X-Device-Info beschrieben.

Es wird dringend empfohlen, sie immer dann zu verwenden, wenn die Geräteplattform der Anwendung die explizite Bereitstellung gültiger Werte zulässt.

Wenn angegeben, führt das Backend für die Adobe Pass-Authentifizierung explizit eingestellte Werte mit extrahierten Werten implizit zusammen (standardmäßig).

Wenn keine Angabe gemacht wird, verwendet das Backend für die Adobe Pass-Authentifizierung implizit die extrahierten Werte (standardmäßig).
required
X-Forwarded-For
Die IP-Adresse des Streaming-Geräts.

Es wird dringend empfohlen, sie immer für Server-zu-Server-Implementierungen zu verwenden, insbesondere wenn der Aufruf vom Programmierdienst und nicht vom Streaming-Gerät erfolgt.

Bei Client-zu-Server-Implementierungen wird die IP-Adresse des Streaming-Geräts implizit gesendet.
fakultativ
Akzeptieren
Der von der Client-Anwendung akzeptierte Medientyp.

Wenn angegeben, muss es application/json sein.
fakultativ
user-agent
Der Benutzeragent der Client-Anwendung.
fakultativ

Antwort

Code
Text
Beschreibung
200
OK
Der Antworttext enthält eine Liste von MVPDs mit einer aktiven Integration mit dem „serviceProvider“.
400
Fehlerhafte Anfrage
Die Anfrage ist ungültig. Der Client muss die Anfrage korrigieren und es erneut versuchen. Der Antworttext kann Fehlerinformationen enthalten, die der Dokumentation Erweiterte Fehlercodes entsprechen.
401
Nicht autorisiert
Das Zugriffstoken ist ungültig. Der Client muss ein neues Zugriffstoken abrufen und es erneut versuchen. Weitere Informationen finden Sie in der Dokumentation Übersicht über die Dynamic Client-Registrierung .
405
Methode nicht zulässig
Die HTTP-Methode ist ungültig. Der Client muss eine HTTP-Methode verwenden, die für die angeforderte Ressource zulässig ist, und erneut versuchen. Weitere Informationen finden Sie im Abschnitt Anfrage.
500
Interner Server-Fehler
Auf der Serverseite ist ein Problem aufgetreten. Der Antworttext kann Fehlerinformationen enthalten, die der Dokumentation Erweiterte Fehlercodes entsprechen.

Erfolg

Kopfzeilen
Status
200
required
content-type
application/json
required
Textkörper

JSON mit einer Liste von Elementen, wobei jedes Element die folgenden Attribute aufweist:

Attribut
Gerät
Gerätetyp
required
clientType
Client-Typ
errorReporting
Objekt
Antragsteller

JSON-Objekt mit den folgenden Attributen:

  • id
    Die interne eindeutige Kennung, die dem Dienstleister während des Onboarding-Prozesses zugeordnet ist.
  • name
    Der kommerzielle (Marken-)Name, der dem Dienstleister während des Onboarding-Prozesses zugeordnet ist.
  • domains
    Die Liste der Domain-Namen, die zur Adobe Pass-Authentifizierung als Darstellung des Dienstleisters aufgeführt sind.
required
mvpds

JSON-Objekt mit den folgenden Attributen:

  • id
    Die interne eindeutige Kennung, die dem Identitätsanbieter während des Onboarding-Prozesses zugeordnet ist.
  • displayName
    Der kommerzielle (Marken-)Name, der dem Identitätsanbieter während des Onboarding-Prozesses zugeordnet ist.
  • logoUrl
    Die URL, von der das mit dem Identitätsanbieter verknüpfte Logo heruntergeladen werden soll.
  • isTempPass
    Das Flag, das angibt, ob die MVPD für die Bereitstellung der Funktionen TempPass ausgelegt ist.
  • isProxy
    Das Flag, das angibt, ob die MVPD eine Proxy-MVPD ist.
  • boardingStatus
    Der Status, der angibt, ob der Identitätsanbieter von der Streaming-Geräteplattform für Single-Sign-On-Flüsse integriert wird.
  • platformMappingId
    Die interne eindeutige Kennung, die dem Identitätsanbieter von der Streaming-Geräteplattform für Single-Sign-On-Flüsse zugeordnet ist.
  • enablePlatformServices
    Das Flag, das angibt, ob die Konfiguration des Identitätsanbieters für Flüsse mit einmaliger Anmeldung für die Plattform des Streaming-Geräts aktiviert ist.
  • displayInPlatformPicker
    Das Flag, das angibt, ob der Identitätsanbieter in der Plattformauswahl für Streaming-Geräte für Single Sign-On-Flüsse angezeigt werden kann.
  • forcePlatformPermissions
    Das Flag, das angibt, ob das Streaming-Gerät die von der Plattform für Single-Sign-On-Flüsse bereitgestellten Benutzerberechtigungen erzwingen muss.
required
Uhrzeit
required
required

Fehler

Kopfzeilen
Status
400, 401, 405, 500
required
content-type
application/json
required
Textkörper
Der Antworttext kann zusätzliche Fehlerinformationen bereitstellen, die der Dokumentation Erweiterte Fehlercodes entsprechen.
required

Beispiele

1. Abrufen der Konfiguration für einen bestimmten Dienstleister

Anfrage
GET /api/v2/REF30/configuration/ HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
Antwort
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "device": "unknown",
    "clientType": "html5",
    "os": "Unknown",
    "requestor": {
        "id": "REF30",
        "name": "Reference site only in 30",
        "domains": [
            {
                "name": "adobe.com",
                "mvpdInitiated": false
            },
            {
                "name": "adobe.io",
                "mvpdInitiated": false
            },
            {
                "name": "adobepass.com",
                "mvpdInitiated": false
            },
            {
                "name": "adobeptime.com",
                "mvpdInitiated": false
            },
            {
                "name": "anvilcreative.com",
                "mvpdInitiated": false
            },
            {
                "name": "testadobe.com",
                "mvpdInitiated": false
            }
        ],
        "mvpds": [
            {
                "id": "AdobePass_SMI",
                "displayName": "Adobe Pass SMI",
                "logoUrl": "https://blogs.adobe.com/conversations/files/2010/08/adobe-logo.jpg",
                "authPerAggregator": false
            },
            {
                "id": "TempPass_TEST40",
                "displayName": "Adobe Temp Pass Test 3 min",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "authPerAggregator": true,
                "isTempPass": true
            },
            {
                "id": "TempPass_TEST44",
                "displayName": "Adobe Temp Pass Test 30 min",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "authPerAggregator": true,
                "isTempPass": true
            },
            {
                "id": "AdobeShibboleth",
                "displayName": "AdobeShibboleth",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/adobe.png"
            },
            {
                "id": "ATTOTT",
                "displayName": "DIRECTV STREAM",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/directvstream.jpg"
            },
            {
                "id": "ElasticSSO",
                "displayName": "ElasticSSO",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "authPerAggregator": false
            },
            {
                "id": "TempPass",
                "displayName": "Temp-Pass",
                "logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
                "passiveAuthnEnabled": false,
                "authPerAggregator": true,
                "isTempPass": true
            },
            {
                "id": "Comcast_SSO_Perf",
                "displayName": "Xfinity Perf",
                "logoUrl": "https://login.comcast.net/static/images/ci/tve/mvpd_comcast_logo112x33.gif",
                "authPerAggregator": true,
                "authPerBrowserSession": true
            }
        ]
    }
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b