Workflow
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 Adobe Pass logout: The streaming application gathers all the necessary data to initiate the logout flow by calling the Adobe Pass Logout endpoint.
IMPORTANT
Refer to the Initiate logout for specific mvpd API documentation for details on:- All the required parameters, like
serviceProvider
,mvpd
, andredirectUrl
- All the required headers, like
Authorization
,AP-Device-Identifier
- All the optional parameters and headers
- All the required parameters, like
-
Find regular profile: The Adobe Pass server identifies a valid profile based on the received parameters and headers.
-
Delete regular profile: The Adobe Pass server deletes the identified regular profile from the Adobe Pass backend.
-
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”.
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
andmvpd
must be active.
If validation fails, an error response will be generated, providing additional information that adheres to the Enhanced Error Codes documentation. - The
-
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. -
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.