Encabezado: AP-Partner-Framework-Status header-ap-partner-framework-status

NOTE
El contenido de esta página se proporciona únicamente con fines informativos. El uso de esta API requiere una licencia actual de Adobe. No se permite el uso no autorizado.

Información general overview

El encabezado de la solicitud AP-Partner-Framework-Status contiene información de estado obtenida de un marco de trabajo de socio para lograr el inicio de sesión único (SSO).

Sintaxis syntax

AP-Partner-Framework-Status: <partner_framework_status_information>
Tipo de encabezado
Encabezado de solicitud
Standard
No

Directivas directives

<partner_framework_status_information>

El valor Base64-encoded del elemento JSON que contiene los atributos siguientes:

Atributo
frameworkPermissionInfo

Este es un atributo obligatorio.

La información de estado de permisos de usuario devuelta por el marco de trabajo del socio y procesada por la aplicación.

Es un elemento JSON con los atributos siguientes:

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
Atributo
accessStatus

Este es un atributo obligatorio.

Esta es una enumeración con los siguientes valores posibles:

  • granted: el usuario permitió que la aplicación accediera a la información de suscripción.
  • denegado: el usuario denegó la solicitud para acceder a la información de suscripción.
  • pendiente: el usuario aún no ha elegido permitir que la aplicación acceda a la información de suscripción.
  • notDetermined: la aplicación no tiene permiso para acceder a la información de suscripción.
error

Es un atributo opcional.

Esto se puede utilizar para pasar el error de marco de socio en caso de que se active uno al consultar la información de estado de permisos de usuario.

Es un elemento JSON con los atributos siguientes:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Atributo
código Una cadena que identifica de forma exclusiva el error tal como lo define el marco de trabajo del socio.
message Una cadena que contiene la descripción del error tal como lo define el marco de trabajo del socio.
frameworkProviderInfo

Este es un atributo obligatorio.

La información de estado de inicio de sesión del proveedor devuelta por el marco de trabajo del socio y procesada por la aplicación.

Es un elemento JSON con los atributos siguientes:

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
Atributo
id Este es un atributo obligatorio.

mappingId que identifica el MVPD utilizado durante el flujo de autenticación a nivel del marco de trabajo del socio.
expirationDate Este es un atributo obligatorio.

Esta es la fecha de caducidad del perfil de usuario autenticado, en caso de que el usuario se haya registrado correctamente usando una MVPD compatible a nivel del marco de trabajo del socio.
error

Es un atributo opcional.

Esto se puede utilizar para pasar el error de marco de socio en caso de que se active uno al consultar la información de estado de inicio de sesión del proveedor.

Es un elemento JSON con los atributos siguientes:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Atributo
código Una cadena que identifica de forma exclusiva el error tal como lo define el marco de trabajo del socio.
message Una cadena que contiene la descripción del error tal como lo define el marco de trabajo del socio.

Ejemplos 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