DocumentaçãoAdobe PassAdobe Pass Authentication

Cabeçalho - AP-Parceiro-Estrutura-Status header-ap-partner-framework-status

Last update: Mon Aug 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
O conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual do Adobe. Não é permitida nenhuma utilização não autorizada.

Visão geral overview

O cabeçalho de solicitação AP-Partner-Framework-Status contém informações de status obtidas de uma estrutura do parceiro para obter o logon único (SSO).

Sintaxe syntax

AP-Partner-Framework-Status: <informações_de_status_do_framework_do_parceiro>
Tipo de cabeçalho
Cabeçalho da solicitação
Padrão
Não

Diretivas directives

<informações_de_status_da_estrutura_do_parceiro>

O valor Base64-encoded do elemento JSON que contém os seguintes atributos:

Atributo
frameworkPermissionInfo

Este é um atributo obrigatório.

As informações de status de permissões do usuário retornadas pela estrutura do parceiro e processadas pelo aplicativo.

Este é um elemento JSON com os seguintes atributos:

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 é um atributo obrigatório.

É uma enumeração com os seguintes valores possíveis:

  • granted - O usuário permitiu que o aplicativo acessasse informações de assinatura.
  • denied - o usuário negou o aplicativo para acessar informações de assinatura.
  • pendente - o usuário ainda não optou por permitir que o aplicativo acessasse as informações de assinatura.
  • notDetermined - O aplicativo não tem permissão para acessar informações de assinatura.
erro

Este é um atributo opcional.

Isso pode ser usado para transmitir o erro da estrutura do parceiro, caso um seja acionado ao consultar as informações de status de permissões do usuário.

Este é um elemento JSON com os seguintes atributos:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Atributo
código Uma string que identifica exclusivamente o erro conforme definido pela estrutura do parceiro.
mensagem Uma string que contém a descrição do erro conforme definido pela estrutura do parceiro.
frameworkProviderInfo

Este é um atributo obrigatório.

As informações de status de logon do provedor retornadas pela estrutura do parceiro e processadas pelo aplicativo.

Este é um elemento JSON com os seguintes atributos:

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 é um atributo obrigatório.

É a mappingId que identifica o MVPD usado durante o fluxo de autenticação no nível da estrutura do parceiro.
expirationDate Este é um atributo obrigatório.

Essa é a data de expiração do perfil do usuário autenticado, caso o usuário tenha se conectado com êxito usando um MVPD compatível no nível da estrutura do parceiro.
erro

Este é um atributo opcional.

Isso pode ser usado para transmitir o erro da estrutura do parceiro, caso um seja acionado ao consultar as informações de status de logon do provedor.

Este é um elemento JSON com os seguintes atributos:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Atributo
código Uma string que identifica exclusivamente o erro conforme definido pela estrutura do parceiro.
mensagem Uma string que contém a descrição do erro conforme definido pela estrutura do parceiro.

Exemplos 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