DocumentationAdobe PassAdobe Pass Authentication

Basic logout flow performed within primary application basic-logout-flow-performed-within-primary-application

Last update: Thu Aug 29 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
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 Logout flow within Adobe Pass Authentication entitlement allows the streaming application to perform two main steps:

  • Delete the regular profiles saved on the Adobe Pass backend.
  • Use a user agent (browser) to navigate to the MVPD logout endpoint, triggering a cleanup on the MVPD backend.

Basic logout flow allows you to query for the following scenarios:

Initiate logout for specific mvpd having logout endpoint initiate-logout-for-specific-mvpd-with-logout-endpoint

Prerequisites prerequisites-initiate-logout-for-specific-mvpd-with-logout-endpoint

Before initiating logout for a specific MVPD with a logout endpoint, ensure the following prerequisites are met:

IMPORTANT
Assumptions
  • The MVPD supports the logout flow and has a logout endpoint.

Workflow workflow-initiate-logout-for-specific-mvpd-with-logout-endpoint

Follow the given steps to implement the basic logout flow for a specific MVPD with a logout endpoint performed within a primary application as shown in the following diagram.

Initiate logout for specific mvpd with logout endpoint

Initiate logout for specific mvpd with logout endpoint

  1. Initiate Adobe Pass logout: The streaming application gathers all the necessary data to initiate the logout flow by calling the Adobe Pass Logout endpoint.

    note important
    IMPORTANT
    Refer to the Initiate logout for specific mvpd API documentation for details on:
    • All the required parameters, like serviceProvider, mvpd, and redirectUrl
    • All the required headers, like Authorization, 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. Delete regular profile: The Adobe Pass server deletes the identified regular profile from the Adobe Pass backend.

  4. Indicate the next action: The Adobe Pass Logout endpoint response contains the necessary data to guide the streaming application regarding the next action:

    • The url attribute is present since the MVPD supports the logout flow.
    • The actionName attribute is set to “logout”.
    • The actionType attribute is set to “interactive”.
    note important
    IMPORTANT
    Refer to the Initiate logout for specific mvpd API documentation for details on the information provided in a logout response.
    The Adobe Pass Logout 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. Initiate MVPD logout: The streaming application reads the url and uses a user agent to initiate the logout flow with the MVPD. The flow may include several redirects to MVPD systems. Still, the result is that the MVPD performs its internal cleanup and sends the final logout confirmation back to the Adobe Pass backend.

  6. Indicate logout complete: The streaming application can wait for the user agent to reach the provided redirectUrl and can use it as a signal to optionally display a specific message on the user interface.

Initiate logout for specific mvpd without logout endpoint initiate-logout-for-specific-mvpd-without-logout-endpoint

Prerequisites prerequisites-initiate-logout-for-specific-mvpd-without-logout-endpoint

Before initiating logout for a specific MVPD without a logout endpoint, ensure the following prerequisites are met:

IMPORTANT
Assumptions
  • The MVPD does not support the logout flow and does not have a logout endpoint.

Workflow workflow-initiate-logout-for-specific-mvpd-without-logout-endpoint

Follow the given steps to implement the basic logout flow for a specific MVPD without a logout endpoint performed within a primary application as shown in the following diagram.

Initiate logout for specific mvpd without logout endpoint

Initiate logout for specific mvpd without logout endpoint

  1. Initiate Adobe Pass logout: The streaming application gathers all the necessary data to initiate the logout flow by calling the Adobe Pass Logout endpoint.

    note important
    IMPORTANT
    Refer to the Initiate logout for specific mvpd API documentation for details on:
    • All the required parameters, like serviceProvider, mvpd, and redirectUrl
    • All the required headers, like Authorization, 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. Delete regular profile: The Adobe Pass server deletes the identified regular profile.

  4. Indicate the next action: The Adobe Pass Logout endpoint response contains the necessary data to guide the streaming application regarding the next action:

    • The url attribute is missing since the MVPD does not support the logout flow.
    • The actionName attribute is set to “complete”.
    • The actionType attribute is set to “none”.
    note important
    IMPORTANT
    Refer to the Initiate logout for specific mvpd API documentation for details on the information provided in a logout response.
    The Adobe Pass Logout 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. Indicate logout complete: The streaming application processes the response and can use it to optionally display a specific message on the user interface.

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