DocumentationAdobe PassAdobe Pass Authentication

Single logout flow single-logout-flow

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.

Initiate single logout for specific mvpd initiate-single-logout-for-specific-mvpd

Prerequisites prerequisites-initiate-single-logout-for-specific-mvpd

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

IMPORTANT
Assumptions
  • The first and second streaming applications obtain the same unique platform identifier payload as JWS or JWE or the same unique user identifier payload as JWS.

Workflow workflow-initiate-single-logout-for-specific-mvpd

Perform the given steps to implement the single logout flow for a specific MVPD as shown in the following diagram.

Initiate single logout for specific mvpd

Initiate single logout for specific mvpd

  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
    The streaming application must ensure it includes a valid value for the unique platform identifier or the unique user identifier before making a request.
    For more details about Adobe-Subject-Token header, refer to the Adobe-Subject-Token documentation.
    For more details about AD-Service-Token header, refer to the AD-Service-Token documentation.

  2. Find regular and single sign-on profiles: The Adobe Pass server identifies both regular and single sign-on valid profiles based on the received parameters and headers.

  3. Delete regular and single sign-on profiles: The Adobe Pass server deletes the identified regular and single sign-on profiles 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.

    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: If the MVPD does not support the logout flow, the streaming application processes the response and can use it to optionally display a specific message on the user interface.

  6. Initiate MVPD logout: If the MVPD does support the logout flow, the streaming application processes the response 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.

  7. 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.

NOTE
The steps for the single logout flow are the same as above, if initiated from the first streaming application.
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b