DocumentationAdobe PassAdobe Pass Authentication

Basic profiles flow performed within primary application basic-profiles-flow-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 Profiles flow within Adobe Pass Authentication entitlement allows the streaming application to access information on active user logins.

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

Retrieve profiles retrieve-profiles

Prerequisites prerequisites-retrieve-profiles

Before retrieving profiles, ensure the following prerequisites are met:

  • The streaming application wants to retrieve all regular profiles.

Workflow workflow-retrieve-profiles

Follow the given steps to implement the basic profiles retrieval flow performed within a primary application as shown in the following diagram.

Retrieve profiles

Retrieve profiles

  1. Retrieve profiles: The streaming application gathers all the necessary data to retrieve all profiles information by sending a request to the Profiles endpoint.

    note important
    IMPORTANT
    Refer to the Retrieve profiles API documentation for details on:
    • All the required parameters, like serviceProvider
    • All the required headers, like Authorization, AP-Device-Identifier
    • All the optional parameters and headers

  2. Find regular profiles: The Adobe Pass server identifies all valid profiles based on the received parameters and headers.

  3. Return information about regular profiles: The Profiles endpoint response contains information about the found profiles associated with the received parameters and headers.

    note important
    IMPORTANT
    Refer to the Retrieve profiles API documentation for details on the information provided in a profile response.
    The Profiles endpoint validates the request data to ensure that basic conditions are met:
    • The required parameters and headers must be valid.
    If validation fails, an error response will be generated, providing additional information that adheres to the Enhanced Error Codes documentation.

  4. Choose a profile and proceed with decisions flows: If the Profiles endpoint response contains profiles, the streaming application uses its internal logic (eventually by interacting with the end user) to choose one of the available profiles to continue with subsequent decisions flows.

  5. Indicate new basic authentication flow: If the Profiles endpoint response does not contain a profile, the streaming application indicates the user to initiate a new basic authentication flow.

Retrieve profile for specific mvpd retrieve-profile-for-specific-mvpd

Prerequisites prerequisites-retrieve-profile-for-specific-mvpd

Before retrieving the profile for a specific MVPD, ensure the following prerequisites are met:

  • The streaming application, which has a selected or cached mvpd identifier, wants to retrieve the regular profile for a specific MVPD.

Workflow workflow-retrieve-profile-for-specific-mvpd

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

Retrieve profile for specific mvpd

Retrieve profile for specific mvpd

  1. Retrieve profile for specific mvpd: The streaming application gathers all the necessary data to retrieve profile information for that specific MVPD by sending a request to the Profiles endpoint.

    note important
    IMPORTANT
    Refer to the Retrieve profile for specific mvpd API documentation for details on:
    • All the required parameters, like serviceProvider and mvpd
    • 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. Return information about regular profile: The Profiles endpoint response contains information about the found profile associated with the received parameters and headers.

    note important
    IMPORTANT
    Refer to the Retrieve profile for specific mvpd API documentation for details on the information provided in a profile response.
    The Profiles 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.

  4. Proceed with decisions flows: If the Profiles endpoint response contains a profile, the streaming application uses the profile information to continue with subsequent decisions flows.

  5. Indicate new basic authentication flow: If the Profiles endpoint response does not contain a profile, the streaming application indicates the user to initiate a new basic authentication flow.

Retrieve profile for specific code retrieve-profile-for-specific-code

Prerequisites prerequisites-retrieve-profile-for-specific-code

Before retrieving the profile for a specific authentication code, ensure the following prerequisites are met:

  • The streaming application, which has a code used to perform the interactive authentication with the MVPD, wants to retrieve the profile for a specific authentication code.

Workflow workflow-retrieve-profile-for-specific-code

Follow the given steps to implement the basic profile retrieval flow for a specific authentication code performed within a primary application as shown in the following diagram.

Retrieve profile for specific code

Retrieve profile for specific code

  1. Retrieve profile for specific code: The streaming application gathers all the necessary data to retrieve profile information for that specific authentication code by sending a request to the Profiles endpoint.

    note important
    IMPORTANT
    Refer to the Retrieve profile for specific code API documentation for details on:
    • All the required parameters, like serviceProvider, and code
    • All the required headers, like Authorization
    • 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. Return information about regular profile: The Profiles endpoint response contains information about the found profile associated with the received parameters and headers.

    note important
    IMPORTANT
    Refer to the Retrieve profile for specific code API documentation for details on the information provided in a profile response.
    The Profiles endpoint validates the request data to ensure that basic conditions are met:
    • The required parameters and headers must be valid.
    If validation fails, an error response will be generated, providing additional information that adheres to the Enhanced Error Codes documentation.

  4. Proceed with decisions flows: If the Profiles endpoint response contains a profile, the streaming application uses the profile information to continue with subsequent decisions flows.

  5. Indicate new basic authentication flow: If the Profiles endpoint response does not contain a profile, the primary application indicates the user to initiate a new basic authentication flow.

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