DocumentationAdobe PassAdobe Pass Authentication

(Legacy) Provide MVPD List provide-mvpd-list

Last update: Fri Dec 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
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
Make sure you stay informed about the latest Adobe Pass Authentication product announcements and decommissioning timelines aggregated in the Product Announcements page.
NOTE
REST API implementation is bounded by Throttling mechanism

REST API Endpoints clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Description description

Returns list of configured MVPDs for the requestor.

Endpoint
Called
By
Input
Params
HTTP
Method
Response
HTTP
Response
<SP_FQDN>/api/v1/config/{requestorId}

For example:

<SP_FQDN>/api/v1/config/sampleRequestorId
Adobe Pass Authentication
1. Requestor
(Path component)
2. deviceType (deprecated)
GET
XML or JSON containing list of MVPDs.
200
Input Parameter
Description
requestor
The Programmer requestorId for which this operation is valid.
deviceType
Device Type.

Sample Response sample-response

Same as existing MVPD XML Response to /config servlet

Note: All MVPDs configured to make use of Platform SSO will have the following extra properties within their corresponding node (JSON/XML):

  • enablePlatformServices (boolean): flag indicating whether this MVPD is integrated via Platform SSO
  • boardingStatus (string): flag indicating the whether the MVPD fully supports Platform SSO (SUPPORTED) or if the MVPD only appears in the platform picker (PICKER)
  • displayInPlatformPicker (boolean): should this MVPD appear in the platform picker
  • platformMappingId (string): the identifier of this MVPD as known by the platform
  • requiredMetadataFields (string array): the user metadata fields expected to be available on a successful login
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b