DokumentationAdobe PassAdobe Pass-Authentifizierung

Erstellen und Abrufen eines Profils mithilfe der Antwort zur Partnerauthentifizierung create-and-retrieve-profile-using-partner-authentication-response

Last update: Tue Sep 02 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
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.

Anfrage request

HTTP
Pfad
/api/v2/{serviceProvider}/profiles/sso/{partner}
Methode
POST
Pfadparameter
serviceProvider
Die interne eindeutige Kennung, die dem Dienstleister während des Onboarding-Prozesses zugeordnet ist.
required
Kamerad
Der Name des Partners (z. B. Apple), der das in den Adobe Pass-Authentifizierungsflüssen integrierte Single-Sign-On-Framework bereitstellt.
required
Hauptteilparameter
SAMLResponse
Die Antwort zur Partnerauthentifizierung, die die erforderlichen Benutzermetadaten zum Erstellen und Speichern eines Partnerprofils enthält.

Der Wert muss Base64-kodiert und danach URL-kodiert sein.
required
Kopfzeilen
Autorisierung
Die Generierung der Bearer-Token-Payload wird in der Dokumentation zur -Kopfzeile.
required
content-type
Der akzeptierte Medientyp für die gesendeten Ressourcen.

Es muss application/x-www-form-urlencoded lauten.
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
ap-partner-framework-status
Die Erstellung der Single Sign-On-Payload für die Partner-Methode wird in der Header-Dokumentation AP-Partner-Framework-Status beschrieben.

Weitere Informationen zu Flüssen, für die Single Sign-on unter Verwendung eines Partners aktiviert ist, finden Sie in der Single Sign-on unter Verwendung von Partnerflüssen Dokumentation.
fakultativ
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
AP-Visitor-Identifier
Die Erstellung der Payload der Besucherkennung wird in der Kopfzeilendokumentation AP-Visitor-Identifier beschrieben.
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 response

Code
Text
Beschreibung
201
Erstellt
Der Antworttext enthält eine Zuordnung gültiger Profile, die leer sein können.
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 success

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

JSON mit einer Zuordnung von Schlüssel-/Wert-Paaren.

Das Schlüsselelement wird durch den folgenden Wert definiert:

table 0-row-3 1-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff layout-auto html-authored
Wert
mvpd Die interne eindeutige Kennung, die dem Identitätsanbieter während des Onboarding-Prozesses zugeordnet ist. required

Das value-Element wird durch die folgenden Attribute definiert:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff layout-auto html-authored
Attribut
notBefore Der Zeitstempel in Millisekunden, vor dem das Profil ungültig ist. required
notAfter Der Zeitstempel in Millisekunden, nach denen das Profil ungültig ist. required
Aussteller

Die Entität, der das Profil gehört.

Die möglichen Werte sind:

  • Apple
    Das Profil wurde erstellt aus: Single Sign-on mit Partner-Apple.
 required
Typ

Der Profiltyp.

Die möglichen Werte sind:

  • appleSSO
    Das Profil wurde erstellt als Ergebnis von: Single Sign-on mit Partner-Apple.
 required
Attribute

JSON mit einer Zuordnung von Schlüssel-/Wert-Paaren.

Das Schlüsselelement wird durch Benutzermetadatenattribute definiert und kann sein:

  • Obligatorisch, wie „userID“
  • Nicht obligatorisch, wie „zip“, „householdID“, „maxRating“ usw.

Die Werte für die Attribute können wie folgt sein:

  • schlicht
  • auflisten
  • kartieren

Benutzermetadaten werden nach Abschluss des Authentifizierungsflusses verfügbar, aber bestimmte Metadatenattribute können während des Autorisierungsflusses aktualisiert werden, je nach MVPD und dem betreffenden spezifischen Metadatenattribut.

 required
required

Fehler error

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.

Die Client-Anwendung muss einen Mechanismus zur Fehlerbehandlung implementieren, der die Fehlercodes, die am häufigsten von dieser API zurückgegeben werden, ordnungsgemäß verarbeitet:

  • invalid_header_pfs_permission_access_not_present
  • invalid_header_pfs_permission_access_not_defined
  • invalid_header_pfs_permission_access_not_granted
  • invalid_header_pfs_provider_id_not_defined
  • invalid_header_pfs_provider_id_mismatch
  • invalid_header_pfs_provider_info_expi
  • invalid_parameter_saml_response
  • usw.

Die obige Liste erhebt keinen Anspruch auf Vollständigkeit. Die Client-Anwendung muss in der Lage sein, alle in der öffentlichen Dokumentation“ definierten erweiterten Fehler-Codes zu.

required

Beispiele samples

​1. Erstellen und Abrufen eines Profils mithilfe der Antwort der Partnerauthentifizierung

Anfrage
code language-https 
POST /api/v2/REF30/profiles/sso/Apple HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiQ2FibGV2aXNpb24iLAogICAgICAiZXhwaXJhdGlvbkRhdGUiIDogIjIwMjU0MzA2MzYwMDAiCiAgICB9Cn0=
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...
Antwort
code language-https 
HTTP/1.1 201 Created

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

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "issuer": "Apple",
            "type": "appleSSO",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        }
     }
}

​2. Profil mithilfe der Antwort der Partnerauthentifizierung erstellen und abrufen, es kommt jedoch zu einer Beeinträchtigung

Anfrage
code language-https 
POST /api/v2/REF30/profiles/sso/Apple HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiJHtkZWdyYWRlZE12cGR9IiwKICAgICAgImV4cGlyYXRpb25EYXRlIiA6ICIyMDI1NDMwNjM2MDAwIgogICAgfQp9
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...
Antwort
code language-https 
HTTP/1.1 200 OK

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

{
    "profiles": {
        "${degradedMvpd}": {
            "notBefore": 1706636062704,
            "notAfter": 1706696062704,
            "issuer": "Adobe",
            "type": "degraded",
            "attributes": {
                "userID": {
                    "value": "95cf93bcd183214ac9e4433153cb8a9d180a463128c0a5d26f202e8c",
                    "state": "plain"
                }
            }
        }
   }
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b