DocumentationAdobe PassAdobe Pass Authentication

Basic profiles flow performed within secondary application basic-profiles-flow-secondary-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 secondary application to access information on active user logins.

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

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 secondary 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 secondary application as shown in the following diagram.

Retrieve profile for specific code

Retrieve profile for specific code

  1. Retrieve profile for specific code: The secondary 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. Indicate authentication flow finished with success: If the Profiles endpoint response contains a profile, the secondary application processes the response and can use it to optionally display a specific message on the user interface.

  5. Indicate authentication flow encountered a problem: If the Profiles endpoint response does not contain a profile, the secondary 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