DocumentationAdobe PassAdobe Pass Authentication

Basic preauthorization flow performed within primary application

Last update: December 6, 2024
  • Topics:
  • Authentication
IMPORTANT
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.
IMPORTANT
REST API V2 implementation is bounded by the Throttling mechanism documentation.

The Preauthorization flow within Adobe Pass Authentication entitlement allows the streaming application to determine whether an MVPD may permit or deny the user’s access to a list of resources. This verification ensures the application can present accurate information to the user about the content they might be eligible to view.

Retrieve preauthorization decisions using specific mvpd

Prerequisites

Before retrieving preauthorization decisions using a specific MVPD, ensure the following prerequisites are met:

  • The streaming application must have a valid regular profile that has been successfully created for the MVPD using one of the basic authentication flows:

    • Perform authentication within primary application
    • Perform authentication within secondary application with preselected mvpd
    • Perform authentication within secondary application without preselected mvpd
  • The streaming application wants to retrieve preauthorization decisions to display a list of resources along with their associated statuses.

Workflow

Follow the given steps to implement the basic preauthorization flow using a specific MVPD performed within a primary application as shown in the following diagram.

Retrieve preauthorization decisions using specific mvpd

Retrieve preauthorization decisions using specific mvpd

  1. Retrieve preauthorization decisions: The streaming application gathers all the necessary data to obtain preauthorization decisions for a list of resources by calling the Decisions Preauthorize endpoint.

    IMPORTANT
    Refer to the Retrieve preauthorization decisions using specific mvpd API documentation for details on:
    • All the required parameters, like serviceProvider, mvpd, and resources
    • All the required headers, like Authorization and AP-Device-Identifier
    • All the optional parameters and headers
  2. Find regular profile: The Adobe Pass server identifies a valid profile based on the received parameters and headers.

  3. Retrieve MVPD decisions for requested resources: The Adobe Pass server calls the MVPD preauthorization endpoint to obtain a Permit or Deny decision for each resource received from the streaming application.

  4. Return preauthorization decisions: The Decisions Preauthorize endpoint response contains a Permit or Deny decision for each resource:

    • A Permit decision means the resource is playable. The response does not include a media token, as the preauthorization flow must not be used to play resources.
    • A Deny decision means the resource is not playable. The response includes an error payload which adheres to the Enhanced Error Codes documentation.
    IMPORTANT
    Refer to the Retrieve preauthorization decisions using specific mvpd API documentation for details on the information provided in a decision response.
    The Decisions Preauthorize endpoint validates the request data to ensure that basic conditions are met:
    • The required parameters and headers must be valid.
    • The integration between the provided serviceProvider and mvpd must be active.
    If validation fails, an error response will be generated, providing additional information that adheres to the Enhanced Error Codes documentation.
  5. Handle preauthorization decisions: The streaming application processes the response and can use it to optionally display the appropriate status for each resource on the user interface.

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b