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

NOTE
Innehållet på den här sidan tillhandahålls endast i informationssyfte. Användning av denna API kräver en aktuell licens från Adobe. Ingen obehörig användning är tillåten.

Ökning overview

Rubriken AP-Partner-Framework-Status innehåller statusinformation som hämtats från ett partnerramverk för att uppnå enkel inloggning (SSO).

Syntax syntax

AP-Partner-Framework-Status: <partner_framework_status_information>
Huvudtyp
Huvud för begäran
Standard
Nej

Direktiv directives

<partner_framework_status_information>

Värdet Base64-encoded för JSON-elementet som innehåller följande attribut:

Attribut
frameworkPermissionInfo

Det här är ett obligatoriskt attribut.

Statusinformation för användarbehörigheter som returneras av partnerramverket och bearbetas av programmet.

Detta är ett JSON-element med följande attribut:

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

Det här är ett obligatoriskt attribut.

Detta är en uppräkning med följande möjliga värden:

  • beviljad
    Användaren tillät programmet att komma åt prenumerationsinformation.
  • nekades
    Användaren nekade programmet åtkomst till prenumerationsinformation.
  • Väntande
    Användaren har ännu inte valt att ge programmet åtkomst till prenumerationsinformation.
  • notDetermined
    Programmet har inte åtkomst till prenumerationsinformation.
fel

Detta är ett valfritt attribut.

Detta kan användas för att skicka fel i partnerramverket om ett fel utlöses när användaren tillfrågas om statusinformation om användarbehörigheter.

Detta är ett JSON-element med följande attribut:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribut
kod En sträng som unikt identifierar felet enligt partnerramverket.
message En sträng som innehåller beskrivningen av felet enligt partnerramverket.
frameworkProviderInfo

Det här är ett obligatoriskt attribut.

Providerinloggningsstatusinformationen som returneras av partnerramverket och bearbetas av programmet.

Detta är ett JSON-element med följande attribut:

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 Det här är ett obligatoriskt attribut.

Detta är det mappingId som identifierar den MVPD som används under autentiseringsflödet på partnerramverksnivå.
expirationDate Det här är ett obligatoriskt attribut.

Detta är förfallodatumet för den autentiserade användarprofilen om användaren har loggat med en MVPD som stöds på partnerramverksnivå.

Detta måste vara en tidsstämpel i millisekunder sedan Unix-epok (t.ex. "1735689600000"), uttryckt som en sträng.
fel

Detta är ett valfritt attribut.

Detta kan användas för att skicka fel i partnerramverket om ett fel utlöses vid sökning efter information om leverantörens inloggningsstatus.

Detta är ett JSON-element med följande attribut:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribut
kod En sträng som unikt identifierar felet enligt partnerramverket.
message En sträng som innehåller beskrivningen av felet enligt partnerramverket.

Exempel 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