DokumentationAdobe PassAdobe Pass-Authentifizierung

Header - AP-Partner-Framework-Status header-ap-partner-framework-status

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
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.

Übersicht overview

Der AP-Partner-Framework-Status-Anfrage-Header enthält Statusinformationen, die von einem Partner-Framework abgerufen wurden, um Single Sign-on (SSO) zu erzielen.

Syntax syntax

AP-Partner-Framework-Status: <partner_framework_status_information>
Kopfzeilentyp
Anfrage-Header
Standard
Nein

Anweisungen directives

<PARTNER_FRAMEWORK_STATUS_INFORMATION>

Der Base64-encoded des JSON-Elements, das die folgenden Attribute enthält:

Attribut
frameworkPermissionInfo

Dies ist ein erforderliches Attribut.

Die vom Partner-Framework zurückgegebenen und von der Anwendung verarbeiteten Statusinformationen zu Benutzerberechtigungen.

Dies ist ein JSON-Element mit den folgenden Attributen:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 10-bgcolor-eff2f7 11-bgcolor-eff2f7 html-authored
Attribut
accessStatus

Dies ist ein erforderliches Attribut.

Dies ist eine Auflistung mit den folgenden möglichen Werten:

  • granted
    Der Benutzer hat der Anwendung erlaubt, auf Abonnementinformationen zuzugreifen.
  • verweigert
    Der Benutzer hat der Anwendung den Zugriff auf Abonnementinformationen verweigert.
  • Ausstehend
    Der Benutzer hat noch nicht ausgewählt, ob die Anwendung auf Abonnementinformationen zugreifen darf.
  • notDetermined
    Die Anwendung darf nicht auf Abonnementinformationen zugreifen.
Fehler

Dies ist ein optionales Attribut.

Dies kann verwendet werden, um den Partner-Framework-Fehler zu übergeben, falls beim Abfragen von Statusinformationen zu Benutzerberechtigungen ein Fehler ausgelöst wird.

Dies ist ein JSON-Element mit den folgenden Attributen:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribut
Code Eine Zeichenfolge, die den Fehler eindeutig identifiziert, wie vom Partner-Framework definiert.
Nachricht Eine Zeichenfolge, die die Beschreibung des Fehlers enthält, wie vom Partner-Framework definiert.
frameworkProviderInfo

Dies ist ein erforderliches Attribut.

Die vom Partner-Framework zurückgegebenen und von der Anwendung verarbeiteten Provider-Anmeldeinformationen.

Dies ist ein JSON-Element mit den folgenden Attributen:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 13-bgcolor-eff2f7 14-bgcolor-eff2f7 html-authored
Attribut
ID Dies ist ein erforderliches Attribut.

Dies ist die mappingId, die die MVPD identifiziert, die während des Authentifizierungsflusses auf Partnerframework-Ebene verwendet wurde.
expirationDate Dies ist ein erforderliches Attribut.

Dies ist das Ablaufdatum des authentifizierten Benutzerprofils, falls der Benutzer sich erfolgreich mit einer unterstützten MVPD auf Partnerframework-Ebene angemeldet hat.
Fehler

Dies ist ein optionales Attribut.

Dies kann verwendet werden, um den Partner-Framework-Fehler zu übergeben, falls bei der Abfrage nach Statusinformationen der Provider-Anmeldung ein Fehler ausgelöst wird.

Dies ist ein JSON-Element mit den folgenden Attributen:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribut
Code Eine Zeichenfolge, die den Fehler eindeutig identifiziert, wie vom Partner-Framework definiert.
Nachricht Eine Zeichenfolge, die die Beschreibung des Fehlers enthält, wie vom Partner-Framework definiert.

Beispiele examples

// Partner framework status information
// {
//    "frameworkPermissionInfo": {
//        "accessStatus": "....",
//        "error": {
//            "code" : "....",
//            "message" : "...."
//        }
//     },
//    "frameworkProviderInfo" : {
//        "id" : "....",
//        "expirationDate" : "....",
//        "error" : {
//            "code" : "...",
//            "message" : "....."
//        }
//     }
// }

// Base64-encoded
// ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAgICJhY2Nlc3NTdGF0dXMiOiAiLi4uLiIsCiAgICAgICAg
// ImVycm9yIjogewogICAgICAgICAgICAiY29kZSIgOiAiLi4uLiIsCiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uIgogICAg
// ICAgIH0KICAgIH0sCiAgICAiZnJhbWV3b3JrUHJvdmlkZXJJbmZvIiA6IHsKICAgICAgICAiaWQiIDogIi4uLi4iLAogICAgICAg
// ICJleHBpcmF0aW9uRGF0ZSIgOiAiLi4uLiIsCiAgICAgICAgImVycm9yIiA6IHsKICAgICAgICAgICAgImNvZGUiIDogIi4uLiIs
// CiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uLiIKICAgICAgICB9CiAgICB9Cn0gIA==

AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAgICJhY2Nlc3NTdGF0dXMiOiAiLi4uLiIsCiAgICAgICAgImVycm9yIjogewogICAgICAgICAgICAiY29kZSIgOiAiLi4uLiIsCiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uIgogICAgICAgIH0KICAgIH0sCiAgICAiZnJhbWV3b3JrUHJvdmlkZXJJbmZvIiA6IHsKICAgICAgICAiaWQiIDogIi4uLi4iLAogICAgICAgICJleHBpcmF0aW9uRGF0ZSIgOiAiLi4uLiIsCiAgICAgICAgImVycm9yIiA6IHsKICAgICAgICAgICAgImNvZGUiIDogIi4uLiIsCiAgICAgICAgICAgICJtZXNzYWdlIiA6ICIuLi4uLiIKICAgICAgICB9CiAgICB9Cn0gIA==
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b