DocumentationAdobe PassAdobe Pass Authentication

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

Last update: Fri Dec 06 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
The content on this page is provided for information purposes only. Usage of this API requires a current license from Adobe. No unauthorized use is permitted.

Overview overview

The AP-Partner-Framework-Status request header contains status information obtained from a partner framework in order to achieve single sign-on (SSO).

Syntax syntax

AP-Partner-Framework-Status: <partner_framework_status_information>
Header Type
Request header
Standard
No

Directives directives

<partner_framework_status_information>

The Base64-encoded value of the JSON element containing the following attributes:

Attribute
frameworkPermissionInfo

This is a required attribute.

The user permissions status information returned by the partner framework and processed by the application.

This is a JSON element with the following attributes:

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

This is a required attribute.

This is an enumeration with the following possible values:

  • granted - The user allowed the application to access subscription information.
  • denied - The user denied the application to access subscription information.
  • pending - The user did not choose yet to allow the application to access subscription information.
  • notDetermined - The application is not allowed to access subscription information.
error

This is an optional attribute.

This can be used to pass the partner framework error in case one is triggered while querying for user permissions status information.

This is a JSON element with the following attributes:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribute
code A string that uniquely identifies the error as defined by partner framework.
message A string that contains the description of the error as defined by partner framework.
frameworkProviderInfo

This is a required attribute.

The provider login status information returned by the partner framework and processed by the application.

This is a JSON element with the following attributes:

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
Attribute
id This is a required attribute.

This is the mappingId which identifies the MVPD used during the authentication flow at the partner framework level.
expirationDate This is a required attribute.

This is the expiration date of the authenticated user profile, in case the user has successfully logged using a supported MVPD at the partner framework level.
error

This is an optional attribute.

This can be used to pass the partner framework error in case one is triggered while querying for provider login status information.

This is a JSON element with the following attributes:

table 0-row-2 1-row-2 2-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 html-authored
Attribute
code A string that uniquely identifies the error as defined by partner framework.
message A string that contains the description of the error as defined by partner framework.

Examples 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