DocumentatieAdobe PassAdobe Pass-verificatie

Besluiten vóór toelating met specifieke mvpd ophalen retrieve-preauthorization-decisions-using-specific-mvpd

Last update: Thu Nov 06 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
De inhoud op deze pagina wordt alleen ter informatie verstrekt. Voor het gebruik van deze API is een huidige licentie van Adobe vereist. Ongeautoriseerd gebruik is niet toegestaan.
IMPORTANT
De implementatie van REST API V2 wordt begrensd door de ​ Throttling mechanisme ​ documentatie.

Verzoek request

HTTP
pad
/api/v2/{serviceProvider}/decisions/preAuthze/{mvpd}
methode
POST
Padparameters
serviceProvider
De interne unieke id die tijdens het instapproces aan de Serviceleverancier is gekoppeld.
vereist
mvpd
De interne unieke id die tijdens het instapproces aan de identiteitsprovider is gekoppeld.
vereist
Bodyparameters
bronnen
De lijst met bronnen waarvoor een MVPD-besluit vereist is voordat deze kunnen worden weergegeven.
vereist
Kopteksten
Toestemming
De generatie van de toonder symbolische nuttige lading wordt beschreven in de 1} kopbaldocumentatie van de Toestemming {.
vereist
Inhoudstype
Het geaccepteerde mediatype voor de bronnen die worden verzonden.

Het moet application/json;charset=utf-8 zijn.
vereist
AP-apparaat-id
De generatie van de apparatenherkenningstekenlading wordt beschreven in AP-apparaat-Identifierkopbaldocumentatie.
vereist
X-Apparaat-Info
De generatie van de lading van de apparateninformatie wordt beschreven in x-apparaat-Infokopbaldocumentatie.

Het wordt ten zeerste aanbevolen deze altijd te gebruiken wanneer het apparaatplatform van de toepassing expliciet geldige waarden biedt.

Als deze optie is opgegeven, worden waarden met geëxtraheerde waarden expliciet samengevoegd met de Adobe Pass-verificatieachterkant (standaard).

Als deze optie niet is opgegeven, gebruikt de Adobe Pass Authentication-backend impliciet geëxtraheerde waarden (standaard).
vereist
X-Forwarded-For
Het IP-adres van het streamingapparaat.

Het wordt sterk geadviseerd om het voor server aan serverimplementaties altijd te gebruiken, vooral wanneer de vraag door de programmeerdienst eerder dan het het stromen apparaat wordt gemaakt.

Voor client-naar-server-implementaties wordt het IP-adres van het streamingapparaat impliciet verzonden.
optioneel
Adobe-Onderwerp-Token
of
x-Roku-Gereserveerd-roku-verbindt-Token
De generatie van enige sign-on lading voor de methode van de Identiteit van het Platform wordt beschreven in Adobe-Subject-Token/ x-Roku-Gereserveerd-roku-Connect-Tokenkopbaldocumentatie.

Voor meer details over enige sign-on toegelaten stromen die een platformidentiteit gebruiken, verwijs naar Enige sign-on gebruikend de stromen van de platformidentiteitdocumentatie.
optioneel
AD-Service-Token
De generatie van enige sign-on lading voor de Symbolische methode van de Dienst wordt beschreven in de AD-dienst-Symbolischekopbaldocumentatie.

Voor meer details over enige sign-on toegelaten stromen gebruikend een de dienstteken, verwijs naar Enige sign-on gebruikend de stromen van het de diensttekendocumentatie.
optioneel
AP-Partner-Kader-Status
De generatie van enige sign-on lading voor de methode van de Partner wordt beschreven in AP-partner-kader-statuskopbaldocumentatie.

Voor meer details over enige sign-on toegelaten stromen die een partner gebruiken, verwijs naar Enige sign-on gebruikend de documentatie van de partnerstromen.
optioneel
AP-bezoeker-id
De generatie van het bezoekersherkenningsteken nuttige lading wordt beschreven in AP-Bezoeker-Herkenningstekenkopbaldocumentatie.
optioneel
Accepteren
Het mediatype dat door de clienttoepassing wordt geaccepteerd.

Indien opgegeven, moet dit application/json;charset=utf-8 zijn.
optioneel
Gebruikersagent
De gebruikersagent van de clienttoepassing.
optioneel

Antwoord response

Code
Tekst
Beschrijving
200
OK
De responsinstantie bevat een lijst van besluiten met aanvullende informatie.
400
Ongeldig verzoek
De aanvraag is ongeldig, de client moet de aanvraag corrigeren en het opnieuw proberen. Het reactielichaam kan fouteninformatie bevatten die aan de Verbeterde documentatie van de Codes van de Foutvolgt.
401
Ongeautoriseerd
Het toegangstoken is ongeldig, moet de cliënt een nieuw toegangstoken verkrijgen en opnieuw proberen. Voor meer details verwijs naar de Dynamische documentatie van de Registratie van de Cliënt van het Overzicht.
405
Methode niet toegestaan
De HTTP-methode is ongeldig, de client moet een HTTP-methode gebruiken die is toegestaan voor de aangevraagde resource en het opnieuw proberen. Voor meer details verwijs naar de 1} sectie van het Verzoek {.
500
Interne serverfout
Er is een probleem opgetreden op de server. Het reactielichaam kan fouteninformatie bevatten die aan de Verbeterde documentatie van de Codes van de Foutvolgt.

Succes success

Kopteksten
Status
200
vereist
Inhoudstype
application/json
vereist
Lichaam
besluiten

JSON bevat een lijst met elementen, elk element met de volgende kenmerken:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff 25-bgcolor-deebff layout-auto html-authored
Kenmerk
resource De resource-id waarvoor het voorafgaande besluit is geretourneerd. vereist
serviceProvider De interne unieke id die tijdens het instapproces aan de Serviceleverancier is gekoppeld. vereist
mvpd De interne unieke id die tijdens het instapproces aan de identiteitsprovider is gekoppeld. vereist
geautoriseerd De beslissingsstatus voor de bron, die ofwel "waar" of "onwaar" kan zijn. vereist
bron

Informatie over de beslissingsbron:

De mogelijke waarden zijn:

  • mvpd
    wordt het Besluit uitgegeven door het voortoelatingseindpunt van MVPD.
  • degradatie
    Besluit wordt uitgegeven als resultaat van gedegradeerde toegang.
  • temppass
    Besluit wordt uitgegeven als resultaat van tijdelijke toegang.
  • dummy
    Besluit wordt uitgegeven als resultaat van dummy preAuthorisation eigenschap.
 vereist
fout De fout verstrekt extra informatie over "ontken"besluit dat aan de Verbeterde Codes van de Foutdocumentatie volgt. optioneel
vereist

Fout error

Kopteksten
Status
400, 401, 405, 500
vereist
Inhoudstype
application/json
vereist
Lichaam

Het reactielichaam kan extra fouteninformatie verstrekken die aan de Verbeterde documentatie van de Codes van de Foutvolgt.

De clienttoepassing moet een foutafhandelingsmechanisme implementeren waarmee de foutcodes die het meest worden geretourneerd door deze API correct kunnen worden verwerkt:

  • authenticated_profile_missing
  • authenticated_profile_expired
  • preauthentication_deny_by_mvpd
  • network_receive_error
  • te_many_resources
  • enz.

De bovenstaande lijst is niet-limitatief. De cliënttoepassing moet alle verbeterde die foutencodes kunnen behandelen in de openbare documentatieworden bepaald.

vereist

Voorbeelden samples

​1. Besluiten tot voorafgaande toestemming met specifieke mvpd intrekken

Verzoek
code language-https 
POST /api/v2/REF30/decisions/preauthorize/Cablevision HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/json
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

{
    "resources": ["resource1", "resource2", "resource3"]
}
Reactie
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
   "decisions": [
      {
         "resource": "resource1 ",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": true
      },
      {
         "resource": "resource2",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": true
      },
      {
         "resource": "resource3",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": false,
         "error": {
            "status": 403,
            "code": "preauthorization_denied_by_mvpd",
            "message": "The MVPD has returned a \"Deny\" decision when requesting pre-authorization for the specified resource.",
            "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=nl-NL",
            "action": "none"
         }
      }
   ]
}

​2. Beslissingen vóór de toelating ophalen met behulp van een specifieke mvpd terwijl de afbraak wordt toegepast

Verzoek
code language-https 
POST /api/v2/REF30/decisions/preauthorize/${degradedMvpd} HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/json
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

{
    "resources": ["REF30", "apasstest1"]
}
Reactie - Verslechtering AuthNAll
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
    ]
}
Reactie - Verslechtering AuthZAll
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
    ]
}
Reactie - Afbraak AuthZNone
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "authorization_denied_by_degradation_rule",
                "message": "The integration has an AuthZNone rule applied for the requested resources",
                "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=nl-NL",
                "action": "none"
            }
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "authorization_denied_by_degradation_rule",
                "message": "The integration has an AuthZNone rule applied for the requested resources",
                "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=nl-NL",
                "action": "none"
            }
        }
    ]
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b