DocumentationAdobe PassAuthentification Adobe Pass

En-tête - AP-Partner-Framework-Status header-ap-partner-framework-status

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Le contenu de cette page est fourni à titre d’information uniquement. L’utilisation de cette API nécessite une licence Adobe actuelle. Aucune utilisation non autorisée n’est autorisée.

Vue d’ensemble overview

L’en-tête de requête AP-Partner-Framework-Status contient des informations de statut obtenues à partir d’un framework de partenaire afin d’obtenir l’authentification unique (SSO).

Syntaxe syntax

AP-Partner-Framework-Status : <partner_framework_status_information>
Type d’en-tête
En-tête de requête
Standard
Non

Directives directives

<partner_framework_status_information>

La valeur Base64-encoded de l’élément JSON contenant les attributs suivants :

Attribut
frameworkPermissionInfo

Il s’agit d’un attribut obligatoire.

Les informations de statut des autorisations utilisateur renvoyées par le framework du partenaire et traitées par l’application.

Il s’agit d’un élément JSON avec les attributs suivants :

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

Il s’agit d’un attribut obligatoire.

Il s’agit d’une énumération avec les valeurs possibles suivantes :

  • authorized
    L’utilisateur a autorisé l’application à accéder aux informations d’abonnement.
  • refusé
    L’utilisateur a refusé que l’application accède aux informations d’abonnement.
  • pending
    L'utilisateur n'a pas encore choisi d'autoriser l'application à accéder aux informations d'abonnement.
  • notDefined
    L’application n’est pas autorisée à accéder aux informations d’abonnement.
erreur

Il s’agit d’un attribut facultatif.

Elle peut être utilisée pour transmettre l’erreur de framework du partenaire au cas où l’une d’elles serait déclenchée lors de la demande d’informations sur le statut des autorisations utilisateur.

Il s’agit d’un élément JSON avec les attributs suivants :

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribut
code Chaîne qui identifie de manière unique l’erreur telle que définie par le framework du partenaire.
message Chaîne contenant la description de l’erreur telle que définie par le framework du partenaire.
frameworkProviderInfo

Il s’agit d’un attribut obligatoire.

Informations sur le statut de connexion du fournisseur renvoyées par le framework du partenaire et traitées par l’application.

Il s’agit d’un élément JSON avec les attributs suivants :

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 Il s’agit d’un attribut obligatoire.

Il s’agit de mappingId qui identifie le MVPD utilisé pendant le flux d’authentification au niveau du framework du partenaire.
expirationDate Il s’agit d’un attribut obligatoire.

Il s’agit de la date d’expiration du profil utilisateur authentifié, au cas où l’utilisateur s’est connecté avec succès à l’aide d’un MVPD pris en charge au niveau du framework du partenaire.
erreur

Il s’agit d’un attribut facultatif.

Elle peut être utilisée pour transmettre l’erreur de framework du partenaire au cas où l’une d’elles serait déclenchée lors de la demande des informations de statut de connexion du fournisseur.

Il s’agit d’un élément JSON avec les attributs suivants :

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribut
code Chaîne qui identifie de manière unique l’erreur telle que définie par le framework du partenaire.
message Chaîne contenant la description de l’erreur telle que définie par le framework du partenaire.

Exemples 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